1.023world API

超ヤドカリ図鑑API では、ヤドカリパーク > 超ヤドカリ図鑑 のデータベースを提供します。 呼び出すAPI のモードにより、科（family）、属（genus）、種（species）のそれぞれのリストを返します。 各レスポンスには、超ヤドカリ図鑑内の該当ページURL、ラテン名、記載者名、和名が含まれ、 加えて種リストには、概要テキスト（抜粋）、サムネイルURL（キャッシュ）も含まれます。

超ヤドカリ図鑑API は、REST（Representational State Transfer）形式で提供されます。 API へのリクエストにはGETを用いてクエリーを渡してください。レスポンスはXMLで返されます。

主にCGI/PHP等を用いてAPIからXMLを取得できますが、JavaScriptからの取得についてもこれらのアシストが必要になります。 詳しくはクロスドメインPHPのページも参考にしてください。

なお、API 側には crossdomain.xml も設置されていますので、FLASHによる取得も可能です。

リクエストURL

http://api.anomura.1023world.net/

リクエストパラメータ

パラメータ	値	説明
---	---	リクエストURL にパラメータを一切与えない場合、 異尾下目/Anomura内の2科（ヤドカリ科/Diogenidae、ホンヤドカリ科/Paguridae）を返します。 例 ： http://api.anomura.1023world.net/
family	string (Latin)	科名を与えることで、該当科内のすべての属リストを返します。以下2つのうちいずれかのみ。 Diogenidae ： ヤドカリ科 Paguridae ： ホンヤドカリ科 「ヤドカリ科」の場合 ： http://api.anomura.1023world.net/?family=Diogenidae
genus	string (Latin)	属名を与えることで、該当属内のすべての種リストを返します。（familyは不要） 「サンゴヤドカリ属」の場合 ： http://api.anomura.1023world.net/?genus=Calcinus
species	string (Latin)	種名を与えることで、該当種の詳細データを返します。（family、genusは不要） 尚、種名はハイフン(-)で連結のこと。（Genus-species形式） 「カシワジマヒメホンヤドカリ」の場合 ： http://api.anomura.1023world.net/?species=Pagurixus-fasciatus

各パラメータはいずれも単独で付加します。 複数のパラメータを組み合わせる必要はありません。

ウェブアプリケーションの開発にあたり、パラメータ無しで科名リストから順に取得して、最終的に種の詳細データまでネストしていくようなフローを構成すると良いでしょう。

レスポンスフィールド

フィールド	説明
result	レスポンス全体を内包するトップレベル要素です。result には以下の属性が与えられています。 type="Anomura-API" family="全科数" genus="全属数" species="全種数" mode="(Family-List|Genus-List|Species-List|Species-Details)"
family	科データを内包する要素です。科リスト時は複数出現します。 result>family
genus	属データを内包する要素です。属リスト時は複数出現します。 result>genus
species	種データを内包する要素です。種リスト時は複数出現します。 result>species
url	1. 超ヤドカリ図鑑内の該当ページURLを内包する要素です。 result>(family|genus|species)>url 2. サムネイル画像（キャッシュ）URLを内包する要素です。 result>species>thumbnail>url * サムネイルURLには約24時間の有効期限が設けられています。
latin	ラテン名を内包する要素です。 result>(family|genus|species)>latin
author	記載者名を内包する要素です。 result>(family|genus|species)>author
japan	和名を内包する要素です。 result>(family|genus|species)>japan
discription	概要テキストの抜粋（半角換算で160文字程度）を内包する要素です。種データにのみ内包されます。 result>species>discription
thumbnail	サムネイルデータを内包する要素です。種データにのみ内包されます。 result>species>thumbnail
width	サムネイル画像の幅（ピクセル値）を内包する要素です。サムネイルデータにのみ内包されます。 result>species>thumbnail>width
height	サムネイル画像の高さ（ピクセル値）を内包する要素です。サムネイルデータにのみ内包されます。 result>species>thumbnail>height
size	サムネイル画像の容量（バイト値）を内包する要素です。サムネイルデータにのみ内包されます。 result>species>thumbnail>size

レスポンスサンプル

実際に取得したXMLをパースするには、以下の各モードの例から各要素の出現パターンを参照して、ウェブアプリケーション開発にお役立てください。 （スキーマの記述は省略しています）

科リストXML取得例 ： http://api.anomura.1023world.net/
属リストXML取得例 ： http://api.anomura.1023world.net/?family=Diogenidae
種リストXML取得例 ： http://api.anomura.1023world.net/?genus=Calcinus
種データXML取得例 ： http://api.anomura.1023world.net/?species=Pagurixus-fasciatus

利用制限

超ヤドカリ図鑑API は、24時間以内で1ホスト（IP）あたり5000件のリクエストが上限となります。 また、サムネイル画像URLには約24時間の有効期限が設けられていますので、データをストックする形式でのご利用はできません。

クレジット表示

超ヤドカリ図鑑API をご利用になる場合、公開するウェブアプリケーションの下（なるべく近い位置）に以下のようなクレジット表示が必要です。 以下のリンクタグをこのままコピーして貼付してください。改変は一切禁止です。
<a href="http://www.1023world.net/api" target="_blank">ウェブサービス by 1.023world</a>