ArtBeat API の使い方
あなたの街の最高のアート・デザインデータベースである Tokyo Art Beat をマッシュアップして、すばらしいウェブアプリケーションを作り上げてください。 Art Beat APIは「非営利」でのご利用、かつ、不当に多いトラフィックを招かない場合において、無料でご利用いただけます。
このAPIを利用したアプリケーションは下記のシンプルなルールに従ってください。
- ・アプリケーションには_www.tokyoartbeat.com_にリンクする形で、“Powered by Tokyo Art Beat”と明記してください。
- ・イベントやスペース情報の「詳細はこちら」へは、www.tokyoartbeat.com以下にリンクしてください。
- ・このAPIからあなたのアプリケーションに取り出されたデータは、最低1時間から1日を超えない範囲で、可能な限りキャッシュしてください。
次のようなケースには Art Beat API Google Group にメッセージをお残しください:
- ・APIに関して問題がある場合。
- ・API組み込みの進捗具合を共有したい場合。
- ・このAPIを使った新しいアプリケーションについて報告したい場合。
次のようなケースにはこちらまでご連絡ください。
- ・このAPIを利用した営利目的でのアプリケーションを開発中、もしくは開発された場合。
- ・アプリケーションから大量のAPIリクエストが予想される場合。
ArtBeat API XML アウトプット
ArtBeat APIでは一貫して、イベントリストを返すメソッドにも、リストにもXMLフォーマットを使っています。
このXMLアウトプットフォーマットでは、ルートエレメントとして <Events> をリストし、それぞれ下記の子エレメントを持っています。
※文字コードはUTF-8になります。
エレメント | 子エレメント | 値、説明 |
---|---|---|
Event | Name, Venue, Description, Image, Karma, Price, DateStart, DateEnd, PermanentEvent, Distance, Datum, Latitude, Longitude | 各イベントの親エレメント |
Venue | Name, Type | 場所に関する情報 |
Name | イベント名 / 場所名 ※Venueの子エレメントとして出力される"Name"エレメントは場所名になります。 | |
Type | 場所の種類 ("美術館"など) | |
Media | メディアの種類 ※複数のメディアが指定されているイベントもあります | |
Description | 概要 ※CDATAセクションで出力されます | |
Image | イベントの画像 30px, 80px, 170pxのものが出力されます | |
Karma | MyTABに登録しているユーザー数によって決定される人気度 | |
Price | 入場料。 | |
DateStart | イベントの開始日 ("YYYY-MM-DD") | |
DateEnd | イベントの終了日 ("YYYY-MM-DD") | |
PermanentEvent | 常設展の場合は"1", そうでない場合は"0" | |
Distance | 緯度・経度に指定した位置からの距離 (単位はm) | |
Datum | 緯度・経度の測地系を出力します ※世界測地系(WGS84)の場合は"world"、東京測地系(日本測地系)の場合は"tokyo"が出力されます | |
Latitude | 緯度 (小数点座標) | |
Longitude | 経度 (小数点座標) |
更新履歴
2008年8月現在、ArtBeat APIで取得できるXMLフォーマットのバージョンは0.1(beta)です。これはこのフォーマットの最初のバージョンになります。
サンプル アウトプット
<?xml version="1.0"?> <Events> <Event xml:lang="ja" id="2008/D38F" href="http://www.tokyoartbeat.com/event/2008/D38F"> <Name>ユーグ・レプ 「パラレルワールド:もう一つの世界」</Name> <Venue href="http://www.tokyoartbeat.com/venue/4A4AABB8"> <Name>東京都現代美術館</Name> <Type>美術館</Type> </Venue> <Media>インスタレーション</Media> <Media>その他</Media> <Description><![CDATA[私たちは目に映る世界にのみ生きているのでしょうか。 もしかすると私たちのすぐそばにもうひとつの世界…]]></Description> <Image src="http://www.tokyoartbeat.com/media/event/2008/D38F-30" width="30" /> <Image src="http://www.tokyoartbeat.com/media/event/2008/D38F-80" width="80" /> <Image src="http://www.tokyoartbeat.com/media/event/2008/D38F-170" width="170" /> <Karma>82.3295</Karma> <Price free="0">大人1500円、学生1000円</Price> <DateStart>2008-07-26</DateStart> <DateEnd>2008-09-28</DateEnd> <DaysBeforeEnd>34</DaysBeforeEnd> <PermanentEvent>0</PermanentEvent> <Distance>466.34028367746</Distance> <Datum>world</Datum> <Latitude>35.679571765284</Latitude> <Longitude>139.80727010194</Longitude> </Event> </Events>
API メソッド: event_searchNear(周辺のイベント)
event_searchNear (周辺のイベント)メソッドは下記のURLで提供されます:
http://www.tokyoartbeat.com/list/event_searchNear
上記URLに、HTTPのGETメソッドを使ってREST方式のパラメーターをクエリーとして問い合わせることで、リソースを取得します。
位置検索用パラメーター: | |
---|---|
Latitude (必須) | 緯度を指定します ※小数点最大6ケタまで。それ以上の精度は無視されます (例:xxx.xxxxxx) |
Longitude (必須) | 経度を指定します ※小数点最大6ケタまで。それ以上の精度は無視されます (例:xxx.xxxxxx) |
Datum | 上記の緯度・経度の測地系を指定します
|
データ抽出用パラメーター | |
Schedule |
|
SearchRange |
|
Description |
|
Free |
|
結果用パラメーター | |
Language | 出力結果の言語を指定します
|
ResultDatum | 出力結果の緯度・経度の測地系を指定します
|
MaxResults | 出力結果の表示数を指定します "5", "10", "20", "50" |
SortOrder | 出力結果の表示順を指定します
|
注意:ユーザーに使いやすくするため、全てのパラメーターと値は大文字、小文字の区別をしていません。
サンプル クエリー
緯度:35.6763 / 経度:139.8105 を基準位置とした場合のサンプルクエリーです。
- http://www.tokyoartbeat.com/list/event_searchNear?Latitude=35.671208&Longitude=139.76517
(日本語でのデフォルト) - http://www.tokyoartbeat.com/list/event_searchNear?Latitude=35.671208&Longitude=139.76517&Language=en
(英語でのデフォルト) - http://www.tokyoartbeat.com/list/event_searchNear?Latitude=35.671208&Longitude=139.76517&MaxResults=5&SortOrder=distance&free=1
(近くの無料のイベントを最大5件取得) - http://www.tokyoartbeat.com/list/event_searchNear?Latitude=35.671208&Longitude=139.76517&Schedule=upcoming&SortOrder=mostpopular
(今後開催される人気のイベントを取得) - http://www.tokyoartbeat.com/list/event_searchNear?Latitude=35.671208&Longitude=139.76517&SortOrder=mostpopular&Free=1
(人気の無料イベントを取得) - http://www.tokyoartbeat.com/list/event_searchNear?Latitude=35.671208&Longitude=139.76517&SortOrder=closingsoon
(もうすぐ終了のイベントを取得)
AS3 Wrapper
この「AS3 Artbeat API」はFlash開発者なら誰でも簡単にArtBeat APIにアクセスすることができる手軽なアクションスクリプト3.0 wrapperです。詳細の説明とダウンロードはReuben StantonのAS3 Artbeat APIサイトから。
ご使用いただいた方
すでにいくつかのアプリケーションやサイトがTABのAPIを使ってくれています。
- フラコレは、「フライヤーはアートだ!!」をコンセプトにした『フライヤーコレクションサイト』です。
- シンプルで使い易いiphone用のサイト