ドコイク？WEBサービスは、ドコイク？の持つ日本全国の店舗・スポット情報を利用して、新しいサービス、サイト、アプリケーションを作成するためのWebサービスです。
店舗情報検索API
各種条件で店舗などのPOIデータを検索し、店舗リストと結果全体で共有される関連データを取得することができます。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| keyword | 検索キーワード | 複数の店舗データに対して全文検索を実施 | 例:新橋 | |
| name | 店舗名称 | 店舗名称だけに部分一致検索を実施。 | 例:カフェ | |
| tel | 電話番号 | 電話番号に完全一致検索を実施。(電話番号は数字のみ。ハイフンや括弧は指定不可) | 例:0900000000 | |
| lat_jgd | 緯度(*1) | 検索中心緯度。単位：世界測地系Degree | 例:35.7309 | |
| lon_jgd | 経度(*1) | 検索中心経度。単位：世界測地系Degree | 例:139.7051 | |
| radius | 検索半径距離 | 検索中心から検索する半径距離。単位：m。指定がない場合は1000m | 例:1 | |
| lmcode | 基点コード | 完全一致検索。複数指定はできません。radiusと組み合わせることで、指定された基点の近隣の店舗を検索できます | 例:209398 | |
| iarea | iエリアコード | NTTドコモが提供しているiエリアコード。完全一致が基本だが、前方一致指定でワイルドカード（*）の利用が可能。複数指定可能*2 | 例:13111 → 13111の完全一致 、13* → 13を先頭に前方一致 | |
| order | 表示順 | 検索結果の表示順 | 1:おまかせ順(デフォルト)、2:距離の近い順、3:オススメ順 | |
| pagenum | 検索の開始ページ | 取得するページ番号（1以上の整数） | 初期値:1 | |
| pagesize | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大20 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかを指定します。JSONの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json。 |
- *1：lat_jgd,lon_jgdを同時に指定しない場合、パラメーターエラーになります
- *2：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,... - *3：基点コード、緯度経度が同時に指定された場合は、基点コードが優先されます。またlat_jgd,lon_jgdを同時に指定しない場合、パラメーターエラーになります
サンプルクエリ
基点名を指定して検索
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| status(属性) | 実行結果 | 0:成功,100:システムエラー,200:認証キーエラー,300:パラメータエラー |
| totalcount(属性) | クエリー条件にマッチする、検索結果の全件数 | 1 |
| pagenum(属性) | 検索結果のページ | 1 |
| poi | 店舗情報 | |
| code | RPIN (Recruit Place Identification Number) | 70498705 |
| name | POI名称 | メディアテクノロジーラボ |
| kana | POI名称よみかな | めでぃあてくのろじーらぼ |
| tel | POI電話番号(ハイフン付き) | 99-9999-9999 |
| address | 住所 | 東京都 中央区 銀座 ７丁目 ３－５ リクルート銀座７丁目ビル５Ｆ |
| stationcode | 最寄り駅の基点コード | 1908 |
| station | 最寄り駅名称 | 銀座駅 |
| distance | 距離 | 519 |
| dokopcurl | ドコイクPC版での店舗詳細URL | |
| dokomburl | ドコイク？携帯版での店舗詳細URL | |
| dokomapurl | ドコイク地図での店舗詳細URL | |
| reviewrank | 過去仕様との互換性のため、0固定でレスポンスします。 | |
| tag | 過去仕様との互換性のため、空要素をレスポンスします |
基点マスタ検索API
指定した条件で、基点データ(駅も含む)を検索することができます。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| name | 基点名 | 基点名の部分一致検索を実施 | 例:タワー | |
| code | 基点コード | 基点コードの完全一致検索を実施 | 例:00000 | |
| lat_jgd | 緯度(*1) | 検索中心緯度。単位：世界測地系Degree | 例:35.7309 | |
| lon_jgd | 経度(*1) | 検索中心経度。単位：世界測地系Degree | 例:139.7051 | |
| radius | 検索半径距離 | 検索中心から検索する半径距離。単位：m。指定がない場合は1000m | 例:1 | |
| iarea | iエリアコード | NTTドコモが提供しているiエリアコード。完全一致が基本だが、前方一致指定でワイルドカード（*）の利用が可能。複数指定可能*2 | 例:13111 → 13111の完全一致 、13* → 13を先頭に前方一致 | |
| pagenum | 検索の開始ページ | 取得するページ番号（1以上の整数） | 初期値:1 | |
| pagesize | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大20 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかを指定します。JSONの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json。 |
サンプルクエリ
基点名を指定して基点を検索
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| status(属性) | 実行結果 | 0:成功,100:システムエラー,200:認証キーエラー,300:パラメータエラー |
| totalcount(属性) | クエリー条件にマッチする、検索結果の全件数 | 1 |
| pagenum(属性) | 検索結果のページ | 1 |
| landmark | 基点 | |
| code | 基点コード | 000000001 |
| name | 基点名 | 東京タワー |
| dokopcurl | ドコイクPC版での店舗詳細URL | |
| dokomburl | ドコイク？携帯版での店舗詳細URL | |
| dokomapurl | ドコイク地図での店舗詳細URL |
駅マスタ検索API
指定した条件で、基点データのうち駅だけを対象に検索することができます。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| name | 駅名 | 駅名の部分一致検索を実施 | 例:新橋 | |
| code | 基点コード | 基点コードの完全一致検索を実施 | 例:00000 | |
| lat_jgd | 緯度(*1) | 検索中心緯度。単位：世界測地系Degree | 例:35.7309 | |
| lon_jgd | 経度(*1) | 検索中心経度。単位：世界測地系Degree | 例:139.7051 | |
| radius | 検索半径距離 | 検索中心から検索する半径距離。単位：m。指定がない場合は1000m | 例:1 | |
| iarea | iエリアコード | NTTドコモが提供しているiエリアコード。完全一致が基本だが、前方一致指定でワイルドカード（*）の利用が可能。複数指定可能*2 | 例:13111 → 13111の完全一致 、13* → 13を先頭に前方一致 | |
| pagenum | 検索の開始ページ | 取得するページ番号（1以上の整数） 最 | 初期値:1 | |
| pagesize | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大20 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかを指定します。JSONの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json。 |
サンプルクエリ
緯度経度を指定して、駅を検索
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| status(属性) | 実行結果 | 0:成功,100:システムエラー,200:認証キーエラー,300:パラメータエラー |
| totalcount(属性) | クエリー条件にマッチする、検索結果の全件数 | 1 |
| pagenum(属性) | 検索結果のページ | 1 |
| landmark | 基点(駅) | |
| code | 基点コード | 000000001 |
| name | 駅名 | 新橋駅 |
| dokopcurl | ドコイクPC版での店舗詳細URL | |
| dokomburl | ドコイク？携帯版での店舗詳細URL | |
| dokomapurl | ドコイク地図での店舗詳細URL | |
| lat_jgd | 緯度。単位：世界測地系Degree | 39.3393 |
| lon_jgd | 経度。単位：世界測地系Degree | 140.7761 |
| lat_tky | 緯度。単位：日本測地系Degree | 39.3393 |
| lon_tky | 経度。単位：日本測地系Degree | 140.7761 |
