doodle APIの使い方

doodle APIの使い方

Ver1.0（07/08/12現在）
※最新版はコチラです。（推奨）
※10/15若干更新分追記修正

REST形式のAPIによるWebサービスを開始しました。

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

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

検索API

リクエストURL

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

リクエストパラメタ

検索パラメタ　　 ※必須項目以外はブランクで構いません

パラメタ名説明

tp APIの種別を指定します。 ※必須（現在1固定でお願いします）

ap APIの認証キーを指定します。 ※必須（現在doodle固定でお願いします）

lat 落書きを取得したい緯度を指定します。 ※必須

lon 落書きを取得したい経度を指定します。 ※必須

range 指定された緯度・経度からの半径の広さをメートル単位で指定します。 ※任意項目（デフォルト値　500）　※恐れ入りますが現在正しく動作しておりません。指定桁数を1桁落とす（5000の場合500）かもしくは指定無しでアプリ側で制限をお願いします。

limit 返される結果の件数の上限値を指定します。 ※任意項目（デフォルト値　30）

type doodleの種類を指定します。
nomal=落書き（07/10/15追加）
eat=めし
stay=やど
station=えき
all=すべて
※任意項目（デフォルト値　all）

search 検索順を指定します。
new=最新順
near=指定された緯度経度から距離が近い順
※任意項目（デフォルト値　最新順）

ver APIのバージョンを指定します。 ※任意項目（現在1.0固定）デフォルト値　Stableバージョン

add リターンパラメタのURLのデリミタ「＆」をHTML（＆ａｍｐ；）形式ではなくそのまま返す場合1を指定します。 ※任意項目(デフォルト値　HTML形式（07/10/15追加）

an マッシュアップ先から書き込みを行う場合の識別子を半角で3文字固定で指定してください。例：ONGMAPの場合「an=ONG」 ※任意項目(デフォルト値　なし（07/10/15追加）

リターンパラメタ

ヒットしたデータをXML形式で返します。

返答パラメタ

パラメタ名説明

doodleno doodle掲示板の番号

distance 指定された緯度経度から該当掲示板までの距離（メートル）

cnt doodle掲示板のコメント数

stime 最終更新時間（UNIXタイム）

date 最終更新時間(可読形式に変換）

directval 指定した緯度経度を基点とした掲示板の方位角の度数

directword 指定した緯度経度を基点とした掲示板の方位角（16分割）（例：北西など。ただしAM6～PM8まではSUN（太陽を基点）

type 掲示板の形式
nomal=通常doodle
eat=めしdoodle
station=えきdoodle
stay=やどdoodle

typeinfo 付随情報
通常doodle=novalue(固定値）
めしdoodle=先頭Jはホットペッパー Webサービスのお店ID、それ以外の番号は食べログ.com レストラン情報取得APIの店舗IDに相当するパラメタ
えきdoodle=駅名
やど=yoyaQ.comホテルプラン情報取得APIのホテルIDに相当するパラメタ

maplink doodleMapのパーマリンク

bbslink doodle掲示板のパーマリンク

description 最新の落書き

lat 掲示板の緯度

long 掲示板の経度

phone 最新書き込みの携帯の機種識別名やブラウザなどの種類

car 最新書き込みのキャリア等の識別名（docomo,au,softbank,willcom,pc,Wii,PSP,DS,other)

エラーコード

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

エラーコード

エラーコード説明

DisabledParam0 検索パラメタapが正しく取得できない

DisabledParam1 必須検索パラメタが正しく取得できない

DisabledParam2 任意検索パラメタが正しく取得できない

NonSupportArea doodleでサポートする地域ではない場合

DataNotFound 検索結果が0件の場合（厳密に言えばエラーではありませんが、識別用に設定しています）

サンプル

渋谷駅近辺の落書きを探す
http://doodle.st/k/api.php?lat=35.658516&lon=139.702234&tp=1&ap=doodle
※今後は「地名」でも検索できるように改良予定。ちなみにその他ご要望や不具合などがあれば、恐れ入りますがコチラのTweetへよろしくお願いします。m(__)m
doodle地図に戻る

検索パラメタ　　 ※必須項目以外はブランクで構いません
パラメタ名	説明
tp	APIの種別を指定します。 ※必須（現在1固定でお願いします）
ap	APIの認証キーを指定します。 ※必須（現在doodle固定でお願いします）
lat	落書きを取得したい緯度を指定します。 ※必須
lon	落書きを取得したい経度を指定します。 ※必須
range	指定された緯度・経度からの半径の広さをメートル単位で指定します。 ※任意項目（デフォルト値　500）　※恐れ入りますが現在正しく動作しておりません。指定桁数を1桁落とす（5000の場合500）かもしくは指定無しでアプリ側で制限をお願いします。
limit	返される結果の件数の上限値を指定します。 ※任意項目（デフォルト値　30）
type	doodleの種類を指定します。 nomal=落書き（07/10/15追加） eat=めし stay=やど station=えき all=すべて ※任意項目（デフォルト値　all）
search	検索順を指定します。 new=最新順 near=指定された緯度経度から距離が近い順 ※任意項目（デフォルト値　最新順）
ver	APIのバージョンを指定します。 ※任意項目（現在1.0固定）デフォルト値　Stableバージョン
add	リターンパラメタのURLのデリミタ「＆」をHTML（＆ａｍｐ；）形式ではなくそのまま返す場合1を指定します。 ※任意項目(デフォルト値　HTML形式（07/10/15追加）
an	マッシュアップ先から書き込みを行う場合の識別子を半角で3文字固定で指定してください。例：ONGMAPの場合「an=ONG」 ※任意項目(デフォルト値　なし（07/10/15追加）

返答パラメタ
パラメタ名	説明
doodleno	doodle掲示板の番号
distance	指定された緯度経度から該当掲示板までの距離（メートル）
cnt	doodle掲示板のコメント数
stime	最終更新時間（UNIXタイム）
date	最終更新時間(可読形式に変換）
directval	指定した緯度経度を基点とした掲示板の方位角の度数
directword	指定した緯度経度を基点とした掲示板の方位角（16分割）（例：北西など。ただしAM6～PM8まではSUN（太陽を基点）
type	掲示板の形式 nomal=通常doodle eat=めしdoodle station=えきdoodle stay=やどdoodle
typeinfo	付随情報通常doodle=novalue(固定値）めしdoodle=先頭Jはホットペッパー Webサービスのお店ID、それ以外の番号は食べログ.com レストラン情報取得APIの店舗IDに相当するパラメタえきdoodle=駅名やど=yoyaQ.comホテルプラン情報取得APIのホテルIDに相当するパラメタ
maplink	doodleMapのパーマリンク
bbslink	doodle掲示板のパーマリンク
description	最新の落書き
lat	掲示板の緯度
long	掲示板の経度
phone	最新書き込みの携帯の機種識別名やブラウザなどの種類
car	最新書き込みのキャリア等の識別名（docomo,au,softbank,willcom,pc,Wii,PSP,DS,other)

エラーコード
エラーコード	説明
DisabledParam0	検索パラメタapが正しく取得できない
DisabledParam1	必須検索パラメタが正しく取得できない
DisabledParam2	任意検索パラメタが正しく取得できない
NonSupportArea	doodleでサポートする地域ではない場合
DataNotFound	検索結果が0件の場合（厳密に言えばエラーではありませんが、識別用に設定しています）