APIリファレンス

>>[旧バージョンのAPIリファレンス]はこちら

リクエスト仕様


本APIを呼び出すときにベースとなるURLと必要なHTTPパラメータの一覧です。GETとPOSTに対応しています。

[注意事項] 短時間の間に過度なリクエストを発行しないようにしてください。 該当ユーザーに対してアクセス制限がかかり一時APIがご利用できなくなる場合があります。

ベースURL

http://webapi.suntory.co.jp/barnavi/v2/shops?


リクエスト例 パラメータをセットしたリクエスト例です。

http://webapi.suntory.co.jp/barnavi/v2/shops?key={APIキー}&pattern=0&pref=26&url={呼び出し元サービスURL}

検索パターンごとに必要なパラメータを記載しています。
記号の意味はそれぞれ、[◎必須][○任意][×使用不可] です。
リクエストパラメータの文字コードはUTF-8です。

パラメータ一覧
パラメータ名 項目名 説明 0:住所検索 1:緯度経度検索 複数指定の上限
key APIキー APIを利用するために割り当てられたキーを設定します。  
pattern 検索パターン 検索するパターンを指定します。
0:住所検索
1:緯度経度検索
0
pref 都道府県 都道府県をコードで指定します。
01:北海道 02:青森県
03:岩手県 04:宮城県
05:秋田県 06:山形県
07:福島県 08:茨城県
09:栃木県 10:群馬県
11:埼玉県 12:千葉県
13:東京都 14:神奈川県
15:新潟県 16:富山県
17:石川県 18:福井県
19:山梨県 20:長野県
21:岐阜県 22:静岡県
23:愛知県 24:三重県
25:滋賀県 26:京都府
27:大阪府 28:兵庫県
29:奈良県 30:和歌山県
31:鳥取県 32:島根県
33:岡山県 34:広島県
35:山口県 36:徳島県
37:香川県 38:愛媛県
39:高知県 40:福岡県
41:佐賀県 42:長崎県
43:熊本県 44:大分県
45:宮崎県 46:鹿児島県
47:沖縄県
×  
address 住所 住所で検索(部分一致)します。 × 大阪府
access アクセス 最寄駅で検索(部分一致)します。 × 5 北新地駅
lat 緯度 検索の中心地の緯度を指定します。 ×  
lng 経度 検索の中心地の経度を指定します。 ×  
range 検索範囲 検索の中心地をmで指定します。

初期値:300
最大値:1000
×  
datum 測地系 緯度・経度の測地系を指定できます。

world:世界測地系 【初期値】
tokyo:日本測地系
×  
name 店名 店名で検索(部分一致)します。 サントリー
type バーのタイプ バーのタイプコードを利用して絞り込みます。

0:全タイプ 【初期値】
1:ダイニングバー
2:ホテルバー
3:ダーツバー
4:ショットバー
5:オーセンティックバー
6:スタンディングバー
7:バール
8:カフェバー
9:スポーツバー
10:アイリッシュパブ
11:プールバー
12:ソウルバー
13:ロックバー
14:ジャズバー
15:ピアノバー
16:ワインバー
17:焼酎バー
18:ガールズバー
17 type=1
&type=2
&type=3

※一行
budget 予算 検索用予算コードを利用して絞り込みます。

01:2,000円未満
02:2,000円以上~3,000円未満
03:3,000円以上~5,000円未満
04:5,000円以上~7,000円未満
05:7,000円以上~10,000円未満
06:10,000円以上
01
private_room 個室 「個室あり」という条件で絞り込むかどうかを指定します。

0:絞り込まない 【初期値】
1:絞り込む
1
capacity 客席数 客席数で絞り込むことができます。指定数より大きな収容人数のお店を検索します。「50人以上」は「capacity=50」と指定します。 50
start 検索の開始位置 検索結果の何件目から取得するかを指定します。

初期値:1
10
count 取得件数 検索結果の何件分を取得するかを指定します。

最小値:1
最大値:100
初期値:10
50
format レスポンス形式 レスポンス形式を指定します。jsonpの場合、パラメータ「callback」を指定する事で、任意のコールバック関数を指定できます。

xml 【初期値】
json
jsonp
jsonp
callback コールバック関数名 パラメータ「format」がjsonpの場合のみ有効になります。コールバック関数の名前を指定します。

初期値:callback
callback
url 呼び出し元サービスURL 呼び出し元のサービスURLを指定してください。  

レスポンス仕様


検索結果のデータは下記のような形式で返却されます。(検索結果は最大100件まで返却)
レスポンスの文字コードはUTF-8です。

レスポンス例

タグ 説明
shops    
  api_version APIのバージョン 2
  results_available クエリー条件にマッチする、検索結果の全件数 300
  results_returned このXMLに含まれる検索結果の件数 40
  results_start 検索結果の開始位置 10
  shop (繰り返しタグ)
    access アクセス JR東西線 北新地駅西口より徒歩1分/JR大阪環状線 大阪駅桜橋出口より徒歩2分
    address 住所 大阪市北区堂島2-1-5
    budget 予算 2,000円以上~3,000円未満
    capacity 客席数 50席
    close 定休日 不定休
    id 店舗ID 66344631N
    lat_tokyo 緯度 日本測地系(Tokyo Datum) 35.0028375
    lat_world 緯度 世界測地系(WGS84) 35.0060668
    lng_tokyo 経度 日本測地系(Tokyo Datum) 135.7735139
    lng_world 経度 世界測地系(WGS84) 135.7706674
    name 店名 SUNTORY BAR
    name_kana 店名(カタカナ表記) サントリー バー
    open 営業時間 17:00~23:30 LO (料理)23:00 (ドリンク)23:15
    private_room 個室 あり
    type バーのタイプ ダイニングバー
    url_mobile モバイル用の店舗URL http://m.suntory.co.jp
/bar-navi/shop/0752510940/
    url_pc PC用の店舗URL http://www.suntory.co.jp
/gourmet/bar-navi/shop/0752510940/
    url_photo_k1 画像極小(サムネイル向け)のURL http://www.suntory.co.jp
/shop_img/k/0752510940_k1.jpg
    url_photo_l1 画像大1のURL http://www.suntory.co.jp
/shop_img/l/0752510940_l1.jpg
    url_photo_l2 画像大2のURL http://www.suntory.co.jp
/shop_img/l/0752510940_l2.jpg
    url_photo_s1 画像小1のURL http://www.suntory.co.jp
/shop_img/s/0752510940_s1.jpg
    url_photo_s2 画像小2のURL http://www.suntory.co.jp
/shop_img/s/0752510940_s2.jpg
    url_photo_s3 画像小3のURL http://www.suntory.co.jp
/shop_img/s/0752510940_s3.jpg
    url_photo_s4 画像小4のURL http://www.suntory.co.jp
/shop_img/s/0752510940_s4.jpg


エラー仕様

APIの呼び出しでエラーが発生した場合、下記の形式のXMLが返されます。

レスポンス例

<?xml version="1.0" encoding="UTF-8"?>
<error>
  <code>001</code>
  <message>パラメータ:keyは必須です。</message>
</error>


エラーコード エラー内容
000 アクセス制限によるエラー
001 パラメーターエラー
002 メンテナンスによるアクセス不可
999 BarNavi API内部でのシステムエラー