以下のAPIはリラク＆ビューティサロン検索専用です。ヘアサロン検索用のマスタとは異なります。ご注意ください
リラク＆ビューティサロンサーチAPI
URL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| id | サロンID | サロンに割り当てられた番号で検索します。 | *1 | (例) H0123456789 |
| name | サロン名 | サロンの名前で検索(部分一致)します。 | ||
| name_kana | サロン名かな | サロンの読みがなで検索(部分一致)します。 | ||
| address | 住所 | サロンの住所で検索(部分一致)します。 | ||
| service_area | サービスエリアコード | エリアに割り当てられたコード番号で検索します。指定できるコード番号はエリアマスタAPIを参照。複数指定する事で OR 検索が可能 *2 | *1 | (例) SA |
| middle_area | 中エリアコード | (例) AAAA | ||
| small_area | 小エリアコード | (例) X001 | ||
| genre | ジャンルコード | ジャンルマスタAPIのコード値で絞り込みます。
特殊記法で OR 検索も可 |
*1 | GR01 |
| feature | 特集コード | 特集マスタAPIのコード値で絞り込みます。
特殊記法で OR 検索も可 |
*1 | SP01 |
| feature_detail | 特集詳細コード | 特集詳細マスタAPIのコード値で絞り込みます。
特殊記法で OR 検索も可 |
*1 | L001 |
| keyword | フリーワード | サロン名、サロン名かな、住所、キャッチのフリーワード検索(部分一致)が可能です。 | *1 | |
| lat | 緯度 | ある地点からの範囲内のサロンの検索を行う場合の緯度です。小数点13桁まで対応。 | *1 | (例) 35.669220 |
| lng | 経度 | ある地点からの範囲内のサロンの検索を行う場合の経度です。小数点13桁まで対応。 | (例) 139.761457 | |
| range | 検索範囲 | ある地点からの範囲内のサロンの検索を行う場合の範囲を5段階で指定できます。 | 1: 300m 2: 500m 3: 1000m (初期値) 4: 2000m 5: 3000m |
|
| datum | 測地系 | 緯度・経度の測地系を指定できます。world: 世界測地系、tokyo: 旧日本測地系。初期値は world。 | (例) world | |
| kodawari | こだわり条件コード | こだわり条件で絞り込むことができます。指定できるコード番号はこだわりマスタAPIを参照。複数指定する事で AND 絞り込みが可能 *2
特殊記法で OR 検索も可 |
(例) 4 | |
| kodawari_setsubi | こだわり設備条件コード | 設備・サービスのこだわり条件で絞り込むことができます。指定できるコード番号はこだわりマスタAPIを参照。複数指定する事で AND 絞り込みが可能 *2
特殊記法で OR 検索も可 |
(例) 2 | |
| kodawari_menu | こだわりメニュー条件コード | メニューのこだわり条件で絞り込むことができます。指定できるコード番号はこだわりメニューマスタAPIを参照。複数指定する事で AND 絞り込みが可能 *2
特殊記法で OR 検索も可 |
(例) 3 | |
| order | ソート順 | 検索結果の並び順を指定します。※位置検索の場合は指定に関係なく、強制的に距離順でソートされます。 | 0: ランダム(初期値) 1: サロン名かな順 2: 小エリアコード順 |
|
| start | 検索の開始位置（何件目か？） | 検索結果の何件目から出力するかを指定します。 | 初期値: 1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 1～100までの半角数字。初期値: 10 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | xml または json または jsonp。初期値: xml。 |
*2 複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
*3 OR 検索モードの指定方法
複数の値を列挙していく中に文字列 'or' を追加する事で AND 検索では無く OR 検索に切り替わります。
(例) hair_image=1,2,3,or あるいは kodawari=3,4&kodawari=or
hair_ryou=1,2,or,3 とした場合も出現位置は関係なく 1 2 3 すべてを一律 OR 検索します。
OR 検索対象の値は最大10個まで指定可能です。
サンプルクエリ
■サロン名 "サロン" で検索 (結果は小エリアコード順)
http://webservice.recruit.co.jp/relax/salon/v1/?key=[APIキー]&name=%E3%82%B5%E3%83%AD%E3%83%B3&order=3
■地点を指定して、その範囲にあるお店を取得
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 251 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 10 |
| results_start | 検索結果の開始位置 | 1 |
| salon | [複数要素] | |
| id | サロンID | H0123456789 |
| last_update | 最終更新日時 | 2007-12-31T11:11:11 |
| name | サロン名 | ホットペッパービューティサロン |
| name_kana | サロン名かな | ホットペッパービューティサロン |
| urls | URL | |
| pc | PC用サロンURL | URL |
| mobile | 携帯向けURL | URL |
| qr | QRコード画像へのURL 画像サイズ等の変更方法はこちら |
URL |
| coupon_urls | クーポンページURL | |
| pc | PC用クーポンページURL | URL |
| mobile | 携帯向けURL | URL |
| qr | QRコード画像へのURL 画像サイズ等の変更方法はこちら |
URL |
| address | 住所 | 東京都中央区銀座８-４-１７ |
| service_area | サービスエリア | |
| code | サービスエリアコード | SA |
| name | サービスエリア名 | 関東 |
| middle_area | 中エリア | |
| code | 中エリアコード | AA |
| name | 中エリア名 | 新宿・下北沢・四ツ谷 |
| small_area | 小エリア | |
| code | 小エリアコード | X001 |
| name | 小エリア名 | 新宿・高田馬場 |
| open | 営業時間 | 12:00～24:00（最終受付24:00） |
| close | 定休日 | 毎週火曜日 |
| credit_card | クレジットカード | 全て |
| staff_num | スタッフ数 | ３人 |
| equipment | 設備 | ベッド4床 |
| parking | 駐車場 | 3台有 |
| note | 備考 | 予約優先。 |
| genre | ジャンル[複数要素] | |
| code | ジャンルコード | GR01 |
| name | ジャンル名 | リラクゼーション |
| kodawari | こだわり条件 | ４席以下の小型サロン/夜１９時以降も受付OK/一人のスタイリストが仕上げまで担当 |
| lat | 緯度（測地系は検索時に指定したもの） | 35.6608183454 |
| lng | 経度（測地系は検索時に指定したもの） | 139.7754267645 |
| catch_copy | キャッチ | TV・雑誌で話題☆海外でも絶賛！ |
| description | ディスクリプション | お勤め帰りやお買い物ついでに立ち寄れる便利な立地にあるサロン。 |
| main | メインコンテンツ | |
| photo | メインフォト | |
| s | Sサイズ（119x89) | 画像URL |
| m | Mサイズ（219x164） | 画像URL |
| l | Lサイズ（349x262） | 画像URL |
| caption | キャプション | 贅沢な空間でリラックスできます。 |
| mood | サロンの雰囲気[複数要素] | |
| photo | サロンの雰囲気フォト | 画像URL |
| caption | サロンの雰囲気キャプション | モダンデザインの外観フォルム |
| feature | 特集詳細 [複数要素] | |
| code | 特集詳細コード | L001 |
| name | 特集詳細名 | 夏のイチオシスタイルがあるサロン |
| g_code | 特集コード | SP01 |
| g_name | 特集名 | 雰囲気から探す |
| caption | キャッチ | 誰にも真似のできないあなただけのオリジナルカラー |
| description | ディスクリプション | カラーやパーマでは９種ものトリートメントで髪の内部から補修。 |
| photo | 特集フォト | |
| s | Sサイズ（119x89) | 画像URL |
| m | Mサイズ（219x164） | 画像URL |
| l | Lサイズ（349x262） | 画像URL |
サービスエリアマスタAPI
サービスエリアのマスタを取得します。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| start | 検索の開始位置（何件目か？） | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | １～１００までの半角数字。初期値:10 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | xml または json または jsonp。初期値:xml。 |
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 3 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 3 |
| results_start | 検索結果の開始位置 | 1 |
| service_area | [複数要素] | |
| code | サービスエリアコード | SA |
| name | サービスエリア名 | 関東 |
中エリアマスタAPI
中エリアのマスタを取得します。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| service_area | サービスエリア | 該当するサービスエリアで絞込みます。複数選択可*1 | (例) SA | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 1～100までの半角数字。初期値: 10 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | xml または json または jsonp。初期値:xml。 |
name=value1&name=value2&...または name=value1,value2,...
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| middle_area | [複数要素] | |
| code | 中エリアコード | AA |
| name | 中エリア名 | 新宿・下北沢・四ツ谷 |
| service_area | ||
| code | サービスエリアコード | SA |
| name | サービスエリア名 | 関東 |
小エリアマスタAPI
小エリアのマスタを取得します。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| middle_area | 中エリア | 該当する中エリアで絞込みます。複数選択可*1 | (例) AB | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 1～100までの半角数字。初期値:10 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | xml または json または jsonp。初期値:xml。 |
name=value1&name=value2&...または name=value1,value2,...
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| small_area | [複数要素] | |
| code | 小エリアコード | X001 |
| name | 小エリア名 | 新宿・高田馬場 |
| middle_area | ||
| code | 中エリアコード | AA |
| name | 中エリア名 | 新宿・下北沢・四ツ谷 |
| service_area | ||
| code | サービスエリアコード | SA |
| name | サービスエリア名 | 関東 |
ジャンルマスタAPI
ジャンルのマスタを取得します。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| genre | ジャンル | 該当するジャンルで絞込みます。複数選択可*1 | (例) GR01 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | xml または json または jsonp。初期値:xml。 |
name=value1&name=value2&...または name=value1,value2,...
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| genre | [複数要素] | |
| code | ジャンルコード | GR02 |
| name | ジャンル名 | 整体・カイロプラクティック・矯正 |
| short_name | ジャンル短縮名 | 整体 |
| desc | 概要 | 整体,カイロプラクティック,骨盤矯正 |
こだわりマスタAPI
こだわりマスタを取得します。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 1～100までの半角数字。初期値:10 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | xml または json または jsonp。初期値:xml。 |
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| kodawari | [複数要素] | |
| code | こだわり条件コード | 1 |
| name | こだわり条件名 | １５席以上の大型サロン |
こだわり設備マスタAPI
こだわり設備マスタを取得します。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | １～１００までの半角数字。初期値:10 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | xml または json または jsonp。初期値:xml。 |
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| kodawari_setsubi | [複数要素] | |
| code | こだわり設備条件コード | 1 |
| name | こだわり設備条件名 | 朝１０時前でも受付OK |
こだわりメニューマスタAPI
こだわりメニューマスタを取得します。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | １～１００までの半角数字。初期値:10 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | xml または json または jsonp。初期値:xml。 |
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| kodawari_menu | [複数要素] | |
| code | こだわりメニュー条件コード | CO01 |
| name | こだわりメニュー条件名 | ボディケア |
| category | メニューカテゴリ [複数要素] | |
| code | カテゴリコード | CA01 |
| name | カテゴリ名 | リラクゼーション |
| genre | ジャンル | |
| code | ジャンルコード | GR01 |
| name | ジャンル名 | リラクゼーション |
特集マスタAPI
特集マスタを取得します。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | １～１００までの半角数字。初期値:100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | xml または json または jsonp。初期値:xml。 |
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| feature | [複数要素] | |
| code | 特集コード | SP01 |
| name | 特集名 | 雰囲気から探す |
特集詳細マスタAPI
特集詳細マスタを取得します。特集マスタをさらに細分化したデータになります。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| feature | 特集コード | 該当する特集で絞込みます。複数選択可*1 | SP01 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | １～１００までの半角数字。初期値:100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | xml または json または jsonp。初期値:xml。 |
name=value1&name=value2&...または name=value1,value2,...
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.00 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| feature_detail | [複数要素] | |
| code | 特集詳細コード | L002 |
| name | 特集詳細名 | ちょっと贅沢なサロン |
| feature | 特集 | 親の特集マスタ情報 |
| code | 特集コード | SP02 |
| name | 特集名 | 雰囲気から探す |
エラー時のレスポンス
<?xml version="1.0" encoding="UTF-8"?>
<results xmlns="http://webservice.recruit.co.jp/relax/">
<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/relax/crossdomain.xml");
このように crossdomain.xml を指定する事で、ご自身のサイト上にある Flash SWF ファイルから、本APIを利用することが可能になります。
