先週の木曜日に、ぐるなびがレストラン検索の API を公開しました。

• ぐるなびWebサービス

所定の URI に所定のパラメータを渡して HTTP で叩くと、検索結果の XML が返ってきます。 非常にシンプル。 で、こいつを PHP でラップしたライブラリを作りました。

• GNavi.php

大したことはやっていないのだけれど、いかんせんリクエスト・パラメータとレストランの属性値の数が多く、手数だけはかかってしまいました。

このライブラリを使うと、こんな感じのアプリがお手軽に作れます。

• GNaviSample.php
• ソースコード

Web サービスのマニュアルはここで提供されています。

• ぐるなびWebサービス ご利用マニュアル

ぐるなびが提供する API を呼ぶには、ユーザー登録をした上でアクセスキーを手に入れる必要があります。 このため、JavaScript などでクライアント・サイドから呼ぶには適しません。 提供されている API は現在のところ五種類です。

• レストラン検索API
• エリアマスタ取得API
• 都道府県マスタAPI
• 大業態マスタ取得API
• 小業態マスタ取得API

このうち検索を行うのは一つ目の「レストラン検索API」のみで、他の四つは常に固定の結果を返します。 業態絞込み検索を行う場合などに、検索画面の表示に使うことができます。

GNavi.php は上記の仕様をラップします。 主に以下の5つの API を提供します。

GNaviRestSearchAPI クラス

レストラン検索です。「2-3-1.レストラン検索API」をラップします。いくつかの検索パラメータ（後述）を受け取ります。検索結果 GNaviRestSearchResult を返します。

GNaviAreaSearchAPI クラス

エリアマスタの取得です。「2-3-2.エリアマスタ取得API」をラップします。検索パラメータは不要です。検索結果 GNaviAreaSearchResult を返します。

GNaviPrefSearchAPI クラス

都道府県マスタの取得です。「2-3-3.都道府県マスタAPI」をラップします。検索パラメータは不要です。検索結果 GNaviPrefSearchResultを返します。

GNaviCategoryLargeSearchAPI クラス

大業態マスタの取得です。「2-3-4.大業態マスタ取得API」をラップします。検索パラメータは不要です。検索結果 GNaviCategoryLargeSearchResult を返します。

GNaviCategorySmallSearchAPI クラス

小業態マスタの取得です。「2-3-5.小業態マスタ取得API」をラップします。検索パラメータは不要です。検索結果 GNaviCategorySmallSearchResult を返します。

各 API クラスの call メソッドは、リクエストがエラーを返した場合は GNaviError クラスのオブジェクトを返します。

各プロパティは「利用案内 2-2. エラー仕様」に準じています。

検索条件は GNaviRestSearchAPIParams クラスで渡します。 基本的には利用マニュアルにある「リクエストパラメータ」をラップしたものですが、coordinates_mode / latitude / longitude はまとめて GeoPoint 型で渡してください。 測地系の違いを吸収します。

検索結果は GNaviRestSearchResult クラスとして戻ります。 以下のクラスを経由して検索結果を取り出せます。

サンプル・コード

// 地域一覧を表示
$keyid = "xxxxxxxx";
$api = new GNaviAreaSearchAPI($keyid);
$result = $api->call();
foreach ($result->areaList as $area) {
  echo ($area->code . ":" . $area->name);
}

サンプル・コード

// 都道府県一覧を表示
$keyid = "xxxxxxxx";
$api = new GNaviPrefSearchAPI($keyid);
$result = $api->call();
foreach ($result->prefList as $pref) {
  echo ($pref->code . ":" . $pref->name . ":" . $pref->areaCode);
}

サンプル・コード

// 大業態一覧を表示
$keyid = "xxxxxxxx";
$api = new GNaviCategoryLargeSearchAPI($keyid);
$result = $api->call();
foreach ($result->categoryLargeList as $categoryLarge) {
  echo ($categoryLarge->code . ":" . $categoryLarge->name);
}

サンプル・コード

// 小業態一覧を表示
$keyid = "xxxxxxxx";
$api = new GNaviCategorySmallSearchAPI($keyid);
$result = $api->call();
foreach ($result->categorySmallList as $categorySmall) {
  echo ($categorySmall->code . ":"
          . $categorySmall->name . ":"
          . $categorySmall->categoryLCode);
}

このライブラリを使用する場合はぐるなびWebサービスの利用規約、ガイドラインに従ってください。

• ぐるなびWebサービス 利用規約
• ぐるなびWebサービス ガイドライン