fc2ブログ

FC2ミニブログPIYO APIの解説とサンプル

PIYOAPIとは

PIYOAPIは、FC2ミニブログPIYOの最新の発言、指定したユーザーの新着メッセージなどの情報を取得するためのインタフェース規約のこと。

API仕様

制限・禁止事項

FC2サーバーに負担をかける行為は禁止と書かれているが、呼出し回数制限などは特に設けられていない。

ほかにもスパム行為を助長するプログラムの禁止などがある。詳しくはPIYO-API利用規約を参照してください。

特徴

  • APIコンテスト開催中
  • 出力フォーマットはXMLのみ
  • ミニブログ系APIに多いBASIC認証を必要としない
  • 取得件数上限は30件
  • プロトコルはREST
  • 無料

APIキーの入手方法

PIYOにログイン後、設定->APIの設定から登録ボタンをクリックし、取得する。
APIキーの入手にはFC2PIYOに登録しておかなければならない。


public 広場の発言を取得する

http://piyo.fc2.com/contents/api/?mode=public&key=APIKEY&limit=**

入力パラメータ

フィールド デフォルト 必須 メモ
mode - public
key - 取得したAPIキーを入力
limit 30 データ取得件数。省略すると30件。

出力パラメータ

フィールド 意味
piyoid PIYOID bonkbonbon
nickname ニックネーム bonk
profimg プロフィール画像URL http://piyo.fc2.com/upfile/1/9/8/
bonkbonbon/bonk_prof.png
no メッセージNo 492005
body メッセージ本文 おはようございます
rescount コメント数 1
date 投稿日時 2008-01-09 09:33:08
tmpfile 添付ファイルURL http://piyo.fc2.com/upfile/***.jpg
tmpmovurl 携帯からの添付ファイル

comment 指定したメッセージNOに付随するコメントと親メッセージを取得する

http://piyo.fc2.com/contents/api/?mode=comment&key=APIKEY&no=MESSAGENO&limit=**

入力パラメータ

フィールド デフォルト 必須 メモ
mode - comment
key - 取得したAPIキーを入力
no - メッセージNO
limit 30 コメントデータ取得件数。省略すると30件。

出力パラメータ(itemlist[親メッセージ])

フィールド 意味
piyoid 親メッセージ投稿者のPIYOID bonkbonbon
nickname 親メッセージ投稿者のニックネーム bonk
profimg 親メッセージ投稿者のプロフィール画像URL http://piyo.fc2.com/upfile/1/9/8/
bonkbonbon/bonk_prof.png
no 親メッセージNo 492005
body 親メッセージ本文 おはようございます
rescount 親メッセージのコメント数 1
date 親メッセージの投稿日時 2008-01-09 09:33:08
tmpfile 親メッセージの添付ファイルURL http://piyo.fc2.com/upfile/***.jpg
tmpmovurl 親メッセージの携帯からの添付ファイル

出力パラメータ(itemcomlist[コメント])

フィールド 意味
piyoid コメント投稿者のPIYOID bonkbonbon
nickname コメント投稿者のニックネーム bonk
profimg コメント投稿者のプロフィール画像URL http://piyo.fc2.com/upfile/1/9/8/
bonkbonbon/bonk_prof.png
no コメントNo 492005
date コメント投稿日時 2008-01-09 09:33:08

user 指定したPIYOIDのメッセージを取得する

http://piyo.fc2.com/contents/api/?mode=user&key=APIKEY&userid=指定する人のPIYOID&limit=***

入力パラメータ

フィールド デフォルト 必須 メモ
mode - user
key - 取得したAPIキーを入力
userid 自分のPIYOID 指定する人のPIYOID
limit 30 データ取得件数。省略すると30件。

出力パラメータ

フィールド 意味
piyoid PIYOID bonkbonbon
nickname ニックネーム bonk
profimg プロフィール画像URL http://piyo.fc2.com/upfile/1/9/8/
bonkbonbon/bonk_prof.png
no メッセージNo 492005
body メッセージ本文 おはようございます
rescount コメント数 1
date 投稿日時 2008-01-09 09:33:08
tmpfile 添付ファイルURL http://piyo.fc2.com/upfile/***.jpg
tmpmovurl 携帯からの添付ファイル

status 指定したPIYOIDのプロフィール、その友達のプロフィールを取得する

http://piyo.fc2.com/contents/api/?mode=status&key=APIKEY&userid=取得する人のPIYOID&option=f

入力パラメータ

フィールド デフォルト 必須 メモ
mode - status
key - 取得したAPIキーを入力
userid 自分のPIYOID プロフィール取得元PIYOID。
option 友達のプロフィールを取得する場合は[f]を入力。

出力パラメータ

フィールド 意味
piyoid PIYOID bonkbonbon
nickname ニックネーム bonk
profimg プロフィール画像URL http://piyo.fc2.com/upfile/1/9/8/
bonkbonbon/bonk_prof.png
blog_title ブログタイトル PIYOPIYO
introduction 紹介文 よろしくおねがいします
blog_url ブログURL http://fc2blogshop.blog13.fc2.com/
homepage_url ホームページURL http://www.bmoo.net/
friends_count PIYOトモの数 5
mes_count 総メッセージ数 45
com_count 総コメント数 10

send ひろばにメッセージを送信する

http://piyo.fc2.com/contents/api/?mode=send&key=APIKEY

入力パラメータ

フィールド デフォルト 必須 メモ
mode - send
key - 取得したAPIキーを入力
pid - 自分のPIYOID。
content - 投稿内容(POST)。エンコードする。255文字以内。UTF-8で送信

出力パラメータ

フィールド 意味
result 投稿に成功したかどうか 成功:0、失敗:1
message 投稿内容またはエラーメッセージ resultが0なら投稿内容、1ならエラーメッセージ

last update: 2008年01月09日

前後の記事

最近の記事

トラックバック

この記事へのトラックバックURL:
http://fc2blogshop.blog13.fc2.com/tb.php/899-4b61c494


コメント

管理者にだけ表示を許可する