API説明
APIとは、他のプログラムでもPIYOにアクセスすることができる外部プログラムインターフェイスです。
当サービスに影響のある過剰なアクセスについては制限させていただく可能性がありますので予めご了承くださいます様、お願い申し上げます。
また、当APIは現在開発途中でありますので予告なく変更する恐れがあります。
1 : public
-
広場の最新の発言を取得する(最大30件)
[URL] : https://piyo.fc2.com/contents/api/?mode=public&key=__APIKEY__&limit=__%d__
[パラメータ] :
- mode : public (必須)
- key : 取得したAPIKEY (必須)
- limit : データ取得件数。省略すると30件
[取得データ : xml形式]
- piyoid : PIYOID
- nickname : ニックネーム
- profimg : メッセージのプロフィール画像
- no : メッセージNO
- body : メッセージ本文
- date : 投稿日時
- rescount : コメント数
- tmpfile : 添付画像
- tmpmovurl : 添付動画のURL
※エラーした場合 : error : %エラーメッセージ%
3 : user
-
指定したPIYOIDのメッセージを取得する。指定送信は除外。最大30件
[URL] : https://piyo.fc2.com/contents/api/?mode=user&key=__APIKEY__&userid=__指定する人のPIYOID__&limit=__%d__
[パラメータ] :
- mode : user (必須)
- key : 取得したAPIKEY (必須)
- userid : 指定する人のPIYOID (省略すると自分の発言を取得)
- limit : データ取得件数。省略すると30件
[取得データ : xml形式]
- piyoid : PIYOID
- nickname : ニックネーム
- profimg : メッセージのプロフィール画像
- no : メッセージNO
- body : メッセージ本文
- date : 投稿日時
- rescount : コメント数
- tmpfile : 添付画像
- tmpmovurl : 添付動画のURL
※エラーした場合 : error : %エラーメッセージ%
4 : status
-
指定したPIYOIDのプロフィール、その友達のプロフィールを取得する。
[URL] : https://piyo.fc2.com/contents/api/?mode=status&key=__APIKEY__&userid=__取得する人のPIYOID__&option=f
[パラメータ] :
- mode : (必須) status
- key : 取得したAPIKEY (必須)
- userid : 取得したい人のPIYOID。省略で自分のプロフィールを取得
- option : f あれば友達のプロフィールも取得
[取得データ : xml形式]
- piyoid : PIYOID
- nickname : ニックネーム
- profimg : メッセージのプロフィール画像
- blog_title : ミニブログのタイトル
- introduction : 自己紹介文
- blog_url : ブログのURL
- homepage_url : ホームページのURL
- friends_count : ピヨともの人数
- mes_count : 書き込み回数
- com_count : コメント回数
※エラーした場合 : error : %エラーメッセージ%
5 : send
-
ひろばにメッセージを送信する
[URL] : https://piyo.fc2.com/contents/api/?mode=send&key=__APIKEY__
[パラメータ] :
- mode : (必須) send
- key : (必須) 取得したAPIKEY
- pid : (必須) 自分のPIYOID (POST)
- content : (必須)投稿内容(POST)。エンコードする。255文字以内。UTF-8で送信
[取得データ : xml形式]
- result : 0 成功 1 失敗
- message : resultが0なら投稿内容、1ならエラーメッセージ
