doodle APIの使い方

Ver1.1(08/06/06現在)※古いバージョンであるVer1.0のリファレンスはコチラにあります

REST形式のAPIによるWebサービスをMA3より提供しております。

doodle APIを利用して生成したページでは、doodleトップページ(http://doodle.st/)へのリンクをお願い致します。
doodle APIは、Mashup Award 4th(MA4)に参加しています。

doodle APIとは、他のプログラムからdoodleにアクセスするために提供している外部プログラムインターフェースです。doodle APIを使用することによって、doodleの掲示板情報等を活用したマッシュアップサイトを作成することができます。APIによるアクセスは1リクエスト/秒までを目安としてください。サービスに影響の出る過剰なアクセスは制限させていただく場合がありますのでご了承ください。

提供APIリスト
  1. 掲示板検索API
  2. つぶやきdoodle/which? API
  3. 人気画像取得API
リクエストURL形式

http://doodle.st/k/api2.php?パラメタ名=パラメタ値...

1:掲示板検索API

与えられた緯度経度をもとに付近のdoodle掲示板情報を最新順に返します
リクエストパラメタ
検索パラメタ   ※必須項目以外は指定なしで構いません
パラメタ名説明
tpAPIの種別を指定します。 ※必須(値=1固定・・・掲示板検索API)
apAPIの認証キーを指定します。 ※必須(現在doodle固定でお願いします)
ref使用するサイトのドメイン名を指定します。 ※必須(例:ref=calta.jp [バスでお出かけマップ[[ http://calta.jp/bybus/ ]]の場合])
lat落書きを取得したい緯度を指定します。 ※必須(世界測地系 度形式)
lon落書きを取得したい経度を指定します。 ※必須(世界測地系 度形式)
range指定された緯度・経度からの半径の広さをメートル単位で指定します。 ※任意項目(デフォルト値 500)
limit返される結果の件数の上限値を指定します。 ※任意項目(デフォルト値 30)
typedoodleの種類を指定します。
nomal=通常の落書き
eat=めし
stay=やど
station=えき
gs=ガソリンスタンド
bar=バー
all=すべて
※任意項目(デフォルト値 all)
verAPIのバージョンを指定します。 ※任意項目(現在1.1固定)デフォルト値 Stableバージョン
addリターンパラメタのURLのデリミタ「&」をHTML(&)形式に変換する場合1を指定します。(formatでXMLを指定する場合ブラウザによって必要になる場合のみご使用ください) ※任意項目(デフォルト値 通常形式)
anマッシュアップ先から書き込みを行う場合の識別子を半角で3文字固定で指定してください。例:ONGMAPの場合「an=ONG」 ※任意項目(デフォルト値 なし)
format返却データの形式を指定します。x=xml形式、j=json形式※任意項目(デフォルト値 j(json形式))
callbackコールバック関数名を任意に指定したい場合その関数名(formatでjsonを指定の場合)※任意項目(デフォルト値 特に指定がない場合は「doodle_jsonp」で返します。関数名として何も返して欲しくない場合(JSON形式で欲しい場合)callback=noと指定してください
chars返答される書き込み情報(マルチバイト)の文字コード変換(非推奨) chars=EUC(EUC-JP)、chars=SJIS(Shift-Jis)※任意項目(デフォルト値 UTF-8)
enc返答される書き込み情報(マルチバイト)をURLエンコードする場合に1を指定※任意項目(デフォルト値 無変換で返します)
リターンパラメタ

ヒットしたデータをJSON(P)またはXML形式で返します。なお原則としてマルチバイトデータはUTF-8形式で返します。

返答パラメタ
パラメタ名説明
doodlenodoodle掲示板の番号
distance指定された緯度経度から該当掲示板までの距離(メートル)
cntdoodle掲示板のコメント数
stime最終更新時間(UNIXタイム)
date最終更新時間(可読形式に変換)
directval指定した緯度経度を基点とした掲示板の方位角の度数
directword指定した緯度経度を基点とした掲示板の方位角(16分割)(例:北西など。ただしAM6~PM8まではSUN(太陽を基点)
type掲示板の形式
nomal=通常doodle
eat=めしdoodle
station=えきdoodle
stay=やどdoodle
gs=ガスdoodle(ガソリンスタンド)
bar=バーdoodle
typeinfo付随情報
通常doodle=novalue(固定値)
めしdoodle=先頭Jはホットペッパー Webサービスのお店ID、 それ以外の番号は食べログ.com レストラン情報取得APIの店舗IDに相当するパラメタ
えきdoodle=駅名
やど=yoyaQ.comホテルプラン情報取得APIのホテルIDに相当するパラメタ
ガスdoodle=ガソリン価格情報WEBサービスapiの店舗IDに相当するパラメタ
maplinkdoodleMapのパーマリンク
bbslinkdoodle掲示板のパーマリンク
description最新の落書き
photo画像や動画が存在する場合、そのURL
lat掲示板の緯度(世界測地系 度形式)
lon掲示板の経度(世界測地系 度形式)
phone最新書き込みの携帯の機種識別名やブラウザなどの種類
car最新書き込みのキャリア等の識別名(docomo,au,softbank,willcom,emobile,pc,Wii,PSP,DS,other)
サンプル1

渋谷駅近辺の落書きを探す(XML形式)
http://doodle.st/k/api2.php?lat=35.658516&lon=139.702234&tp=1&ap=doodle&ref=demosite.com&format=x&add=1

サンプル2

JSONP形式でJavaScriptとして呼び出す場合、コールバック関数名で呼び出せば
サーバサイドの処理系を用いることなくクロスドメイン環境でマッシュアップが可能です。

例:六本木界隈の落書きを画像や携帯動画つきでリスト表示する

実行結果


2:つぶやきdoodle/which? API

doodleもしくはWhich?のデータからランダムで1件のみデータを返します
リクエストパラメタ
検索パラメタ   ※必須項目以外は指定なしで構いません
パラメタ名説明
tpAPIの種別を指定します。 ※必須(値=2固定・・・つぶやきAPI)
apAPIの認証キーを指定します。 ※必須(現在doodle固定でお願いします)
ref使用するサイトのドメイン名を指定します。 ※必須(例:ref=calta.jp [バスでお出かけマップ[[ http://calta.jp/bybus/ ]]の場合])
type呼び出すデータの種類を指定します。
doodle=通常の落書き
which=which?のデータ
rnd=双方ランダム
※任意項目(デフォルト値 rnd(双方ランダム))
verAPIのバージョンを指定します。 ※任意項目(現在1.1固定)デフォルト値 Stableバージョン
addリターンパラメタのURLのデリミタ「&」をHTML(&)形式ではなくそのまま返す場合1を指定します。 ※任意項目(デフォルト値 通常形式)
format返却データの形式を指定します。x=xml形式、j=json形式※任意項目(デフォルト値 j(json形式))
callbackコールバック関数名を任意に指定したい場合その関数名(formatでjsonを指定の場合)※任意項目(デフォルト値 特に指定がない場合は「doodle_jsonp」で返します。関数名として何も返して欲しくない場合(JSON形式で欲しい場合)callback=noと指定してください
chars返答される書き込み情報(マルチバイト)の文字コード変換(非推奨) chars=EUC(EUC-JP)、chars=SJIS(Shift-Jis)※任意項目(デフォルト値 UTF-8)
enc返答される書き込み情報(マルチバイト)をURLエンコードする場合に1を指定※任意項目(デフォルト値 無変換で返します)
リターンパラメタ

ヒットしたデータをJSON(P)もしくはXML形式で返します。なお原則としてマルチバイトデータはUTF-8形式で返します。

返答パラメタ
パラメタ名説明
keynodoodle掲示板の番号もしくはWhich?の番号
type返却データの種類(doodle or which?)
stime最終更新時間(UNIXタイム)
maplinkdoodleMapもしくはWhich?回答のパーマリンク
descriptionつぶやきデータ(doodle書き込み or Which?質問)
サンプル1

XML形式で出力
http://doodle.st/k/api2.php?tp=2&ap=doodle&ref=demosite.com&format=x&add=1

サンプル2

何かシュールな一言をつぶやくガジェットをJSONPで作ってみた♪

コード例:

※サンプル2のブログパーツはコチラ

3:人気画像取得 API

doodleで投稿された画像情報を人気順に出力します
リクエストパラメタ
検索パラメタ   ※必須項目以外は指定なしで構いません
パラメタ名説明
tpAPIの種別を指定します。 ※必須(値=3固定・・・人気画像取得API)
apAPIの認証キーを指定します。 ※必須(現在doodle固定でお願いします)
ref使用するサイトのドメイン名を指定します。 ※必須(例:ref=calta.jp [バスでお出かけマップ[[ http://calta.jp/bybus/ ]]の場合])
limit返される結果の件数の上限値を指定します。 ※任意項目(デフォルト値 30)
search出力順を指定します。
new=最新の降順
hot=人気順
rnd=ランダム
※任意項目(デフォルト値 rnd(ランダム))
verAPIのバージョンを指定します。 ※任意項目(現在1.1固定)デフォルト値 Stableバージョン
addリターンパラメタのURLのデリミタ「&」をHTML(&)形式に変換する場合1を指定します。(formatでXMLを指定する場合ブラウザによって必要になる場合のみご使用ください) ※任意項目(デフォルト値 通常形式)
format返却データの形式を指定します。x=xml形式、j=json形式※任意項目(デフォルト値 j(json形式))
callbackコールバック関数名を任意に指定したい場合その関数名(formatでjsonを指定の場合)※任意項目(デフォルト値 特に指定がない場合は「doodle_jsonp」で返します。関数名として何も返して欲しくない場合(JSON形式で欲しい場合)callback=noと指定してください
chars返答される書き込み情報(マルチバイト)の文字コード変換(非推奨) chars=EUC(EUC-JP)、chars=SJIS(Shift-Jis)※任意項目(デフォルト値 UTF-8)
enc返答される書き込み情報(マルチバイト)をURLエンコードする場合に1を指定※任意項目(デフォルト値 無変換で返します)
リターンパラメタ

ヒットしたデータをJSON(P)またはXML形式で返します。なお原則としてマルチバイトデータはUTF-8形式で返します。

返答パラメタ
パラメタ名説明
doodlenodoodle掲示板の番号
stime最終更新時間(UNIXタイム)
date最終更新時間(可読形式に変換)
maplinkdoodleMapのパーマリンク
bbslinkdoodle掲示板のパーマリンク
mesコメントを出力
photo画像のURL
lat画像の緯度(世界測地系 度形式)
lon画像の経度(世界測地系 度形式)
サンプル

人気画像を新しい順に出力(XML形式)
http://doodle.st/k/api2.php?tp=3&ap=doodle&ref=demosite.com&format=x&add=1


エラーコード(共通)

検索した結果エラーの場合にその内容をJSON(P)またはXML形式で返します。

※XMLの場合<Error><Message>エラーコード</Message></Error>、JSONの場合 items:[title:[エラーコード]]にて返却します
エラーコード
エラーコード説明
1検索パラメタapが正しく取得できない
2必須検索パラメタが正しく取得できない
3任意検索パラメタが正しく取得できない
4doodleでサポートする地域ではない場合
5doodleAPIに障害がある場合
0検索結果が0件の場合(厳密に言えばエラーではありませんが、識別用に設定しています)

※仕様変更がある場合は当ページにてお知らせします。何かご要望や不具合などがあれば、
 恐れ入りますがコチラのTweetへよろしくお願いします。m(__)m

※MA4期間中、当APIに関する質問はお受け致しますが、当APIを使用した結果に関する
 個別のアプリケーションに対する動作確認等のお問い合わせは受けかねますのでご了承ください。

doodle地図に戻る


Copyright© kehi.biz All rights reserved.