APIのURL変更のお知らせ(2018/09/03)

ぐるなびWebサービスでは、より利便性の高いサービスを提供するため、APIのバージョンアップを実施いたしました。これに伴い、URLが下記のように変更となります
旧バージョンのAPIからの変更内容に関しては、2018/09/03掲載のお知らせ及び、各APIのマニュアルをご覧ください。
今後のアップデートも考慮し、お手数ですが最新バージョンのAPIへURLのご変更をご対応いただきますようお願いいたします。

旧バージョンのAPIは、2019年09月03日に提供を終了いたします。

以下は、レストラン検索APIの変更例です。各APIの具体的な変更内容は、下の表をご確認ください。
[変更前]http://api.gnavi.co.jp/RestSearchAPI/20150630/
[変更後]http://api.gnavi.co.jp/RestSearchAPI/v3/

API名 最新バージョン 旧バージョン(2019年09月03日提供終了予定)
レストラン検索API https://api.gnavi.co.jp/RestSearchAPI/v3/ https://api.gnavi.co.jp/RestSearchAPI/20150630/
多言語版レストラン検索API https://api.gnavi.co.jp/ForeignRestSearchAPI/v3/ https://api.gnavi.co.jp/ForeignRestSearchAPI/20150630/
応援口コミAPI https://api.gnavi.co.jp/PhotoSearchAPI/v3/ https://api.gnavi.co.jp/PhotoSearchAPI/20150630/
エリアマスタ取得API https://api.gnavi.co.jp/master/AreaSearchAPI/v3/ https://api.gnavi.co.jp/master/AreaSearchAPI/20150630/
都道府県マスタAPI https://api.gnavi.co.jp/master/PrefSearchAPI/v3/ https://api.gnavi.co.jp/master/PrefSearchAPI/20150630/
エリアLマスタAPI https://api.gnavi.co.jp/master/GAreaLargeSearchAPI/v3/ https://api.gnavi.co.jp/master/GAreaLargeSearchAPI/20150630/
エリアMマスタAPI https://api.gnavi.co.jp/master/GAreaMiddleSearchAPI/v3/ https://api.gnavi.co.jp/master/GAreaMiddleSearchAPI/20150630/
エリアSマスタAPI https://api.gnavi.co.jp/master/GAreaSmallSearchAPI/v3/ https://api.gnavi.co.jp/master/GAreaSmallSearchAPI/20150630/
大業態マスタ取得API https://api.gnavi.co.jp/master/CategoryLargeSearchAPI/v3/ https://api.gnavi.co.jp/master/CategoryLargeSearchAPI/20150630/
小業態マスタ取得API https://api.gnavi.co.jp/master/CategorySmallSearchAPI/v3/ https://api.gnavi.co.jp/master/CategorySmallSearchAPI/20150630/

注意事項

  • 旧バージョンのAPIは、2019年09月03日にてご提供を停止します。
  • https://api.gnavi.co.jp/RestSearchAPI/ まででバージョンの指定がないURLや、無効なバージョンのURLでAPIアクセスがあった場合は、2019年09月03日の旧バージョン提供終了までは旧バージョンのAPIへリンクいたします。それ以降は最新バージョンのAPIへリンクいたしますのでご注意ください。バージョン更新の告知は必ずトップページのお知らせや、FacebookTwitter各アカウントなどでご確認いただけますようお願いいたします。

各APIアップデート詳細

対象API 改修内容詳細
全API共通
  • CORS対応を実施しました。これにより、javascriptでの非同期通信によるAPIレスポンスの取得が可能になります。
  • XML・JSONP形式でのレスポンス提供を終了し、レスポンス形式がJSON形式のみとなりました。これに伴い、format・callbackパラメータも提供終了となりました。format・callbackパラメータをいずれかでも指定した場合、エラーレスポンスが返却されます。
  • httpによるリクエスト受付を終了しました。httpでリクエストがあった場合は、エラーレスポンスが返却されます。
  • JSON形式のレスポンスフォーマットが取得結果数により変わる問題を修正しました。
  • JSON形式で返却される値の文字コードをUTF-8に変更しました。
  • エラーレスポンスの最適化を実施しました。
レストラン検索API
  • input_coordinates_mode・coordinates_modeパラメータのデフォルトを1:日本測地系から2:世界測地系に変更しました。それぞれのパラメータに値を指定しない場合は、2:世界測地系を指定した状態と同様の挙動となります。
  • category_l・category_sパラメータにカンマ区切りで10個までコードを指定することが可能になりました。複数コードを指定した場合、OR検索となります。
  • レスポンスヘッダの最適化を実施しました。
  • レスポンス項目のopentime・holiday・pr_short・pr_longの改行コードを\nに変更しました。レスポンス内の<BR>タグを改行に用いていた方は、改行が反映されなくなるためお気をつけください。
  • レスポンス項目のupdate_dateのフォーマットがISO8601準拠となりました。
多言語版レストラン検索API
  • name_kanaパラメータの提供を終了しました。name_kanaパラメータを指定してAPIを呼び出した場合、エラーレスポンスが返却されます。
  • input_coordinates_mode・coordinates_modeパラメータのデフォルトを1:日本測地系から2:世界測地系に変更しました。それぞれのパラメータに値を指定しない場合は、世界測地系を指定した状態と同様の挙動となります。
  • category_l・category_sパラメータにカンマ区切りで10個までコードを指定することが可能になりました。複数コードを指定した場合、OR検索となります。
  • レスポンスヘッダの最適化を実施しました。
  • レスポンス項目のbusiness_hour・holiday・pr_short・pr_longの改行コードを\nに変更しました。レスポンス内の<BR>タグを改行に用いていた方は、改行が反映されなくなるためお気をつけください。
  • レスポンス項目のupdate_dateのフォーマットがISO8601準拠となりました。
応援口コミAPI
  • レスポンス項目のupdate_dateのフォーマットがISO8601準拠となりました。
さっそく「ぐるなび API」を使ってみる