![eruca.[エルーカ] ご利用案内](/common/images/side-goriyou.png)
![eruca.[エルーカ] APIリファレンス](/common/images/side-ref.png)
エルーカWebサービスを使うことで、エルーカに掲載されている、ショップ情報・アイテム情報にアクセスして、アプリケーションを構築することができます。
ショップ検索 API
ショップの一覧を取得できます。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| id | ショップコード | ショップ毎のコード。複数指定可能*1 | (例) 90000462 | |
| name | ショップ名 | ショップ名。部分一致で検索します。 | (例) 銀座店 | |
| lat | 緯度 | ある地点からの範囲内のショップの検索を行う場合の緯度です。 | (例)35.669220 | |
| lng | 経度 | ある地点からの範囲内のショップの検索を行う場合の経度です。 | (例)139.761457 | |
| range | 検索範囲 | ある地点からの範囲内のショップの検索を行う場合の検索範囲です。 | 1:500m 2:1000m 3:5km(初期値) 4:10km 5:50km |
|
| datum | 測地系 | 緯度・経度の測地系を指定できます。world (世界測地系)、tokyo (日本測地系) | 初期値はworld | |
| area | エリアコード | エリア毎のコード。複数指定可能*1 | (例) 0001,0004 | |
| brand | ブランドコード | ブランド毎のコード。複数指定可能*1 | (例) 0058 | |
| keyword | フリーワード | 文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。複数指定可能*1。 別途クエリ項目 kwic=1 を指定する事で Keyword In Context 機能も利用可能 (詳細はこちらを参照)。 フリーワードを指定して、かつ並び順 order に何も指定しない場合、検索結果は「フリーワードマッチ順」でソートされます。 対象：ショップ名、ショップ名カナ、住所、取扱ブランド、PRコメント、ショップジャンル名、エリア名 |
例: かわいい | |
| keyword_or | フリーワード(OR検索) | 文字コードはUTF8。半角スペース区切りの文字列 (最大5単語まで) を渡すことでOR検索になる。上記フリーワード (keyword) 指定がある場合、こちらは無視される。複数指定可能*1。 別途クエリ項目 kwic=1 を指定する事で Keyword In Context 機能も利用可能 (詳細はこちらを参照)。 フリーワードを指定して、かつ並び順 order に何も指定しない場合、検索結果は「フリーワードマッチ順」でソートされます。 対象：ショップ名、ショップ名カナ、住所、取扱ブランド、PRコメント、ショップジャンル名、エリア名 |
例: かわいい 渋谷 | |
| kiwc | KWICレスポンス設定 | クエリ項目「フリーワード」を利用の際、追加でこの kwic に値 1 を指定する事で API レスポンスに KWIC コンテンツを追加させる事ができます (詳細はこちらを参照) 。 | 例:1 | |
| order | ソート順 | 検索結果の並び順を指定します。 1:おすすめ順(デフォルト） 2:ショップ名カナ昇順、 3:ショップ名カナ降順、 4:ショップ名英数昇順、 5:ショップ名英数降順、 6:近い順（緯度経度指定した場合のみ有効で、緯度経度指定した場合のデフォルト) |
例:1 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xmlまたはjsonまたはjsonp |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
個数の上限が指定されてる場合は、その数を超えたパラメータは無視されます。
サンプルクエリ
ブランド一覧を取得
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| shop | ショップ [複数要素] | |
| id | ショップコード | 10001120 |
| name | ショップ名 | MTL Cafe 銀座店 |
| name_kana | ショップ名カナ | エムティーエル カフェ ギンザテン |
| brand | ブランド | |
| id | ブランドコード | 0001 |
| name | ブランド名 | MTLカフェ |
| address | 住所 | 東京都中央区銀座７丁目３－５ |
| billding_name | 建物名 | リクルート銀座７丁目ビル |
| area | エリア | |
| id | エリアコード | 0007 |
| name | エリア名 | 銀座・有楽町・丸の内 |
| lat | 経度（測地系は検索時に指定したもの） | 35.6571138133 |
| lng | 緯度（測地系は検索時に指定したもの） | 139.7555103391 |
| access | アクセスルート | 東京メトロ銀座一丁目駅5番出口を出て右手に直進。 |
| open | 営業時間 | 10:30-20:00 |
| close | 定休日 | 無休(元日を除く) |
| tel | 電話番号 | 00-0000-0000 |
| photo | ||
| gaikan | ||
| caption | 外観写真キャプション | |
| pc | ||
| l | 外観写真PC用URL サイズL | |
| m | 外観写真PC用URL サイズM | |
| s | 外観写真PC用URL サイズS | |
| mobile | ||
| l | 外観写真モバイル用URL サイズL | |
| s | 外観写真モバイル用URL サイズM | |
| naikan1 | ||
| caption | 内観写真1キャプション | |
| pc | ||
| l | 内観写真1PC用URL サイズL | |
| m | 内観写真1PC用URL サイズM | |
| s | 内観写真1PC用URL サイズS | |
| mobile | ||
| l | 内観写真1モバイル用URL サイズL | |
| s | 内観写真1モバイル用URL サイズS | |
| logo | ||
| pc | ショップロゴPC用URL | |
| mobile | ショップロゴモバイル用URL | |
| url | ショップ詳細URL | |
| update | 最終更新日 |
アイテム検索 API
アイテムの一覧を取得できます。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| id | アイテムコード | アイテム毎のコード。複数指定可能*1 | (例) 0001 | |
| name | アイテム名 | アイテム名で検索 | パンプス | |
| large_genre | 大ジャンルコード | 大ジャンルコード。 複数指定可能*1 | (例) 001 | |
| small_genre | 小ジャンルコード | 小ジャンルコード。 複数指定可能*1 | (例) 001001 | |
| price | 価格帯コード | 価格帯コード。複数指定可能*1 | (例) 1 | |
| brand | ブランドコード | ブランド毎のコード。複数指定可能*1 | (例) 0001 | |
| shop | ショップコード | ショップ毎のコード。複数指定可能*1 | (例) 10000000 | |
| order | ソート順 | 検索結果の並び順を指定します。 1:おすすめ順(デフォルト） 2:新着順、 3:人気ランキング順、 4:安い順、 5:高い順 |
例:1 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xmlまたはjsonまたはjsonp |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
個数の上限が指定されてる場合は、その数を超えたパラメータは無視されます。
サンプルクエリ
エリア一覧を取得
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| item | アイテム [複数要素] | |
| id | アイテムコード | |
| name | アイテム名 | |
| large_genre | ||
| id | 大ジャンルコード | |
| name | 大ジャンル名 | |
| small_genre | ||
| id | 小ジャンルコード | |
| name | 小ジャンル名 | |
| price | 価格 | 5250円 |
| pricecd | 価格帯コード | 1 |
| photo | ||
| pc | ||
| l | 写真PC用URL サイズL | |
| m | 写真PC用URL サイズM | |
| s | 写真PC用URL サイズS | |
| mobile | ||
| l | 写真モバイル用URL サイズL | |
| m | 写真モバイル用URL サイズM | |
| s | 写真モバイル用URL サイズS | |
| brand | ブランド | |
| id | ブランドコード | 9999 |
| name | ブランド名 | MTL Cafe |
| shop | ショップ [複数要素] | |
| id | ショップコード | 0001 |
| name | ショップ名 | MLT Cafe 銀座店 |
| name_kana | ショップ名カナ | エムティーエル カフェ ギンザテン |
| url | ショップ詳細URL | |
| url | アイテム詳細URL | |
| update | 最終更新日 |
オトク・イベント検索 API
オトク・イベントの一覧を取得できます。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| id | オトクコード | オトク毎のコード。複数指定可能*1 | (例) 0001 | |
| name | オトク名 | オトク名。部分一致で検索します。 | (例) 下北沢 | |
| ticket | チケットフラグ | チケットフラグ。0:すべて（デフォルト)、1:eruca.オトクチケット、2:イベント | ||
| from | 期間 - 開始 | 期間について絞り込みます | ||
| to | 期間 - 終了 | 期間について絞り込みます | ||
| shop | ショップコード | 指定したショップで絞り込みます | ||
| brand | ブランドコード | 指定したブランドで絞り込みます | ||
| theme | オトクテーマコード | オトクテーマコードで絞り込み | ||
| order | ソート順 | 検索結果の並び順を指定します。 1:おすすめ順(デフォルト） 2:新着順、 3:オトク・イベント開催日順 |
例:1 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xmlまたはjsonまたはjsonp |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
個数の上限が指定されてる場合は、その数を超えたパラメータは無視されます。
サンプルクエリ
オトク・イベントの一覧を取得
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| otoku | オトク [複数要素] | |
| id | オトクコード | |
| name | タイトル | |
| category | カテゴリー | |
| photo | ||
| pc | ||
| l | 写真PC用URL サイズL | |
| m | 写真PC用URL サイズM | |
| s | 写真PC用URL サイズS | |
| mobile | ||
| l | 写真モバイル用URL サイズL | |
| m | 写真モバイル用URL サイズM | |
| s | 写真モバイル用URL サイズS | |
| from | 期間開始日 | |
| to | 期間終了日 | |
| theme | ||
| id | オトクテーマコード | |
| name | オトクテーマ名 | |
| brand | ブランド | |
| id | ブランドコード | 0001 |
| name | ブランド名 | aigle |
| shop | ショップ [複数要素] | |
| id | ショップコード | 0001 |
| name | ショップ名 | aigle |
| name_kana | ショップ名カナ | カフェ |
| url | ショップ詳細URL | |
| url | オトク詳細URL | |
| update | 最終更新日 |
コーディネイト検索 API
コーディネイトの一覧を取得できます。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| id | コーディネイトコード | コーディネイト毎のコード。複数指定可能*1 | (例) 0001 | |
| name | コーディネイト名 | コーディネイト名。部分一致で検索します。 | (例) 下北沢 | |
| brand | ブランドコード | ブランド毎のコード。複数指定可能*1 | (例) 0001 | |
| shop | ショップコード | ショップ毎のコード。複数指定可能*1 | (例) 0001 | |
| order | ソート順 | 検索結果の並び順を指定します。 1:新着順(デフォルト） 2:投票数順 |
例:1 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xmlまたはjsonまたはjsonp |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
個数の上限が指定されてる場合は、その数を超えたパラメータは無視されます。
サンプルクエリ
コーディネイト一覧を取得
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| coordinate | コーディネイト [複数要素] | |
| id | コーディネイトコード | |
| name | コーディネイト名 | |
| photo | ||
| pc | ||
| l | 写真PC用URL サイズL | |
| s | 写真PC用URL サイズS | |
| mobile | ||
| l | 写真モバイル用URL サイズL | |
| s | 写真モバイル用URL サイズS | |
| brand | ブランド | |
| id | ブランドコード | 0001 |
| name | ブランド名 | aigle |
| shop | ショップ [複数要素] | |
| id | ショップコード | 0001 |
| name | ショップ名 | mtl |
| name_kana | ショップ名カナ | エムティーエル |
| url | ショップ詳細URL | |
| url | コーディネイト詳細URL | |
| update | 最終更新日 |
エリアマスタ API
エリアの一覧を取得できます。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| id | エリアコード | エリア毎のコード。複数指定可能*1 | (例) 0001 | |
| name | エリア名 | エリア名。部分一致で検索します。 | (例) 下北沢 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xmlまたはjsonまたはjsonp |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
個数の上限が指定されてる場合は、その数を超えたパラメータは無視されます。
サンプルクエリ
エリア一覧を取得
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| area | エリア [複数要素] | |
| id | エリアコード | 0001 |
| name | エリア名 | 渋谷 |
アイテム大ジャンルマスタ API
アイテム大ジャンルの一覧を取得できます。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| id | アイテム大ジャンルID | アイテム大ジャンル毎のコード。複数指定可能*1 | (例) 001 | |
| name | アイテム大ジャンル名 | アイテム大ジャンル名。部分一致で検索します。 | (例) ワンピース | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xmlまたはjsonまたはjsonp |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
個数の上限が指定されてる場合は、その数を超えたパラメータは無視されます。
サンプルクエリ
アイテム大ジャンル一覧を取得
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| large_genre | アイテム大ジャンル [複数要素] | |
| id | アイテム大ジャンルID | 001 |
| name | アイテム大ジャンル名 | カットソー・Tシャツ |
アイテム小ジャンルマスタ API
アイテム小ジャンルの一覧を取得できます。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| id | アイテム小ジャンルID | アイテム小ジャンル毎のコード。複数指定可能*1 | (例) 001 | |
| name | アイテム小ジャンル名 | アイテム小ジャンル名。部分一致で検索します。 | (例) ワンピース | |
| large_genre | アイテム大ジャンルID | アイテム大ジャンルID。 複数指定可能*1 | (例) 001 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xmlまたはjsonまたはjsonp |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
個数の上限が指定されてる場合は、その数を超えたパラメータは無視されます。
サンプルクエリ
アイテム大ジャンル一覧を取得
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| small_genre | アイテム小ジャンル [複数要素] | |
| id | アイテム小ジャンルID | 001 |
| name | アイテム小ジャンル名 | タンクトップ・Tシャツ |
| large_genre | アイテム大ジャンル | |
| id | アイテム大ジャンルID | 001 |
| name | アイテム大ジャンル名 | カットソー・Tシャツ |
価格帯マスタ API
価格帯の一覧を取得できます。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| id | 価格帯ID | 価格帯毎のコード。複数指定可能*1 | (例) 1 | |
| name | 価格帯名 | 価格帯名。部分一致で検索します。 | (例) 5000以下 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xmlまたはjsonまたはjsonp |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
個数の上限が指定されてる場合は、その数を超えたパラメータは無視されます。
サンプルクエリ
価格帯一覧を取得
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| price | 価格帯 [複数要素] | |
| id | 価格帯ID | 1 |
| name | 価格帯名 | 5001〜10000 |
ブランドマスタ API
ブランドの一覧を取得できます。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| id | ブランドコード | ブランド毎のコード。複数指定可能*1 | (例) 0001 | |
| name | ブランド名 | ブランド名。部分一致で検索します。 | (例) MTLカフェ | |
| order | ソート順 | 検索結果の並び順を指定します。1:ブランドコード昇順(デフォルト）、2:ブランドコード降順、3:ブランド名昇順、4:ブランド名降順 | 例:1 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xmlまたはjsonまたはjsonp |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
個数の上限が指定されてる場合は、その数を超えたパラメータは無視されます。
サンプルクエリ
ブランド一覧を取得
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| brand | ブランド [複数要素] | |
| id | ブランドコード | 0001 |
| name | ブランド名 | MTLカフェ |
| name_kana | ブランド名カナ | エムティーエルカフェ |
| url | ブランドページURL |
オトクテーマ検索 API
オトクテーマの一覧を取得できます。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| id | オトクテーマコード | オトクテーマ毎のコード。複数指定可能*1 | (例) 0001 | |
| name | オトクテーマ名 | オトクテーマ名。部分一致で検索します。 | (例) チケット | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xmlまたはjsonまたはjsonp |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
個数の上限が指定されてる場合は、その数を超えたパラメータは無視されます。
サンプルクエリ
オトクテーマを検索
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| special | オトクテーマ [複数要素] | |
| id | オトクテーマコード | 0001 |
| name | オトクテーマ名 | プライスOFFの嬉しいチケット |
エラー時のレスポンス
<?xml version="1.0" encoding="UTF-8"?>
<results xmlns="http://webservice.recruit.co.jp/eruca/">
<api_version>1.00</api_version>
<error>
<message>keyは必須パラメーターです</message>
</error>
</results>
エラーの際でも、HTTPレスポンスステータスは常に "200 OK" が返ります。実装側では常にレスポンスXMLの内容を見てエラー判断を行ってください。
Flashからの利用方法
Flash Action Script 2.0にて本APIを利用するには1フレーム目に下記の記述を追加する必要があります:
System.security.loadPolicyFile("http://webservice.recruit.co.jp/eruca/crossdomain.xml");
このように crossdomain.xml を指定する事で、ご自身のサイト上にある Flash SWF ファイルから、本APIを利用することが可能になります。
