海外旅行検索API
エイビーロード(AB-ROAD)に掲載中のツアー情報から、複数の軸での検索が可能です。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| id | ツアーID | ツアー毎のIDこの項目を指定した場合はym,ymdを除くその他の絞込みクエリはすべて無視されます。複数指定可能*2 | *1 | (例)AB123456 |
| area | エリアコード | エリアマスタAPI参照。同時にcountryやcityの指定があった場合は無視される。複数指定する事で OR 検索が可能 *2
特殊記法で AND 絞り込みも可 |
*1 | (例)EUR |
| country | 国コード | 国マスタAPI参照。同時にcityの指定があった場合は無視される。複数指定する事で OR 検索が可能 (最大20個まで) *2
特殊記法で AND 絞り込みも可 |
*1 | (例)BE |
| city | 都市コード | 都市マスタAPI参照。複数指定する事で OR 検索が可能 (最大20個まで) *2
特殊記法で AND 絞り込みも可 |
*1 | (例)NYC |
| hotel | ホテルコード | ホテルマスタAPI参照。複数指定する事で OR 検索が可能 *2
特殊記法で AND 絞り込みも可 |
*1 | (例)73393 |
| keyword | フリーワード | 文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。複数指定可能*2。
NEW 別途クエリ項目 kwic=1 を指定する事で Keyword In Context 機能も利用可能 (詳細はこちらを参照)。 NEW フリーワードを指定して、かつ並び順 order に何も指定しない場合、検索結果は「フリーワードマッチ順」でソートされます。 |
*1 | (例)ベトナム 癒し |
| keyword_or | フリーワード (OR検索) | 文字コードはUTF8。半角スペース区切りの文字列 (最大5単語まで) を渡すことでOR検索になる。上記フリーワード (keyword) 指定がある場合、こちらは無視される。複数指定可能*2。
NEW 別途クエリ項目 kwic=1 を指定する事で Keyword In Context 機能も利用可能 (詳細はこちらを参照)。 NEW フリーワードを指定して、かつ並び順 order に何も指定しない場合、検索結果は「フリーワードマッチ順」でソートされます。 | *1 | (例) 赤 太陽 |
| theme | テーマコード | テーママスタAPI参照。複数指定する事で OR 検索が可能 *2
特殊記法で AND 絞り込みも可 |
*1 | 000001 |
| theme_group | テーマグループコード | テーママスタAPI の検索クエリ項目「グループコード」参照。複数指定する事で OR 検索が可能 *2
特殊記法で AND 絞り込みも可 |
*1 | G00004 |
| ad_type | 掲載区分 | ツアー商材の掲載区分で絞込みます。 | *1 | なし:全ツアー (デフォルト) F:オススメツアー |
| osusume | オススメ | 「夫婦にオススメのツアー」「グループにオススメのツアー」など、同行者を指定してツアーの絞込みができます。指定するコード値はオススメマスタAPI参照。複数指定する事で OR 検索が可能 *2 この項目を使用すると自動的に ad_type=F (掲載区分 = オススメ) も指定された事になります。 特殊記法で AND 絞り込みも可 |
*1 | (例) 007 |
| dept | 出発地 | コードで指定。複数指定する事で OR 検索が可能 *2
特殊記法で AND 絞り込みも可 |
TYO:東京 NGO：名古屋 OSA:大阪 FUK:福岡 999:その他 |
|
| ym | 出発月 | 200708 (6桁yyymm)または 0708 (4桁yymm)または 08 (2桁mm:今年の8月)または 8 (1桁m:今年の8月)。あるいは今月からの相対指定も可能 *3 | (例)0708 | |
| ymd | 出発日 | 20070812 (8桁yyyymmdd)または 070812 (6桁yymmdd)または 0812 (4桁mmdd:今年の8月12日)。ymとymd両方を指定していた場合はymdが優先。あるいは今月からの相対指定も可能 *3 | (例)070812 | |
| price_min | 価格帯下限 | この価格以上のツアーを検索。 単位は円 | (例)30000 | |
| price_max | 価格帯上限 | この価格以下のツアーを検索。 単位は円 | (例)100000 | |
| term_min | 期間下限 | この期間以上のツアーを検索。 単位は日 | (例)3 | |
| term_max | 期間上限 | この期間以下のツアーを検索。 単位は日 | (例)10 | |
| airline | 航空会社 | 航空会社マスタPI参照。複数指定する事で OR 検索が可能 *2
特殊記法で AND 絞り込みも可 |
(例)A0 | |
| kodaw | こだわり項目 | こだわりマスタ参照。コードで指定。複数指定する事で OR 検索が可能 *2
特殊記法で AND 絞り込みも可 |
1:フリープラン 2:午前便 3:午後便 4:夜便 5:添乗員つき 6:子供・幼児割引 7:送迎つき 8:航空会社指定 9:ホテル指定 10:アーリーチェックイン 11:レイトチェックアウト |
|
| order | ソート順 | 検索結果の並び順を指定します。
NEW 検索クエリ項目「フリーワード」を指定しつつ、この order に何も指定をしなかった場合は自動的に「フリーワードマッチ順」でソートされます (AB-ROAD独自定義のワード適合ロジック)。 |
0:新着順(更新日付が新しいツアーから表示) 1:価格安い順 2:価格高い順 3:期間短い順 4:期間長い順 5:ランキング順（人気のツアー順。デフォルト) |
|
| kwic | KWICレスポンス設定 NEW | クエリ項目「フリーワード」を利用の際、追加でこの kwic に値 1 を指定する事で API レスポンスに KWIC コンテンツを追加させる事ができます (詳細はこちらを参照) 。 | 1 ※その他拡張設定については左記ドキュメント参照 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。。 |
*1 id指定の場合、その他絞込みパラメータは無視される (e.g. 国/都市/価格/期間など)
*2 複数指定可能パラメータの指定方法
name=value1&name=value2&...または name=value1,value2,... (最大20個まで)
*3 +1m, +6m 等で今月からの月加算 (+0m:今月)、+1d, +30d (日加算)でも +1y (年加算)でも可。※プラス記号(+)は省略可。
サンプルクエリ
東京発ヨセミテ関連のツアーを検索
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.01 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 251 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 10 |
| results_start | 検索結果の開始位置 | 1 |
| tour | [複数要素] | |
| id | ツアーのID | AD236272 |
| last_update | 最終更新日時 | 2007-12-31T11:11:11Z |
| term | 期間 | 8 |
| title | ツアー名 | マサイマラ5つ星ホテルに4連泊。チータを探そう |
| airline | 利用航空会社[複数要素] | |
| code | 航空会社名コード | |
| name | 航空会社名（船利用の場合は「船」） | エイビーロード航空 |
| carr_flg | 航空会社の指定・共同運行・未定の区別 | 指定 |
| airline_summary | 利用航空会社要約（航空会社の文字列airline要素のnameを接続した文字列） | エイビーロード航空、世界航空 |
| brand | ブランド | |
| code | ブランド名のコード | 1866299001 |
| name | 旅行のブランド名 | AB TRAVEL 世界の旅 |
| city_summary | 宿泊地要約（すべての宿泊地の文字列city要素のnameを接続した文字列） | サンブル、ナクル、マサイマラ、ナイロビ |
| dept_city | 出発地 | |
| name | 出発地名称 | 東京 |
| code | 出発地コード | TYO |
| hotel | ホテル(宿泊地ごと)[複数要素] | |
| code | ホテルコード（ホテル指定の場合のみ、コードあり） | 73393 |
| name | ホテル名（クラス名や、同等の場合もあり） | サファリ・ロッジ・ホテル |
| city | ホテル所在都市 | |
| code | ホテル所在都市コード | C14 |
| name | ホテル所在都市名 | ナクル |
| hotel_summary | ホテル要約（すべてのホテルの文字列city要素のnameを接続した文字列） | インターナショナルホテル又は同等クラス(ナイロビ)、サファリ・ロッジ・ホテル(マサイマラ) |
| kodawari | 詳細条件[複数要素] | |
| code | 条件コード | 1 |
| name | 名称 | フリープラン |
| price | 価格 | |
| all_month | 全期間（申し込み可能な期間）の価格 | |
| min | 全期間の最低価格(円) | 10000 |
| max | 全期間の最高価格(円) | 100000 |
| min | 検索対象期間の最低価格(円) | 20000 |
| max | 検索対象期間の最高価格(円) | 50000 |
| oil_surcharge | 燃油サーチャージ情報 | |
| include | 価格に対するサーチャージ料金の扱い。コード値 0:サーチャージ無し、1:サーチャージ料金は価格に含まれている、 2:サーチャージ料金は価格に含まれていない(別) | 1 |
| summary | 料金サマリー | |
| min | 燃油サーチャージ最低価格 | 20000 |
| max | 燃油サーチャージ最高価格 | 50000 |
| type | 上記 min/max 価格の種別。コード値 1:確定価格、2:目安価格 | |
| sche | 宿泊地(行程順)[複数要素] | |
| day | 日（通し番号） | 1 |
| city | 宿泊地の都市（機中泊等もあり） | |
| code | 都市コード | C14 |
| name | 都市名 | ナクル |
| lat | 緯度 (世界測地系) *1 | 51.5091700000 |
| lng | 経度 (世界測地系) *1 | -0.1263430000 |
| area | 都市が属するエリア | |
| code | エリアコード | CAF |
| name | エリア名 | アフリカ•他 |
| country | 都市が属する国 | |
| code | 国コード | KE |
| name | 国名 | ケニア |
| urls | エイビーロード(AB-ROAD)のツアー詳細ページのURL | |
| mobile | モバイル用 | URL |
| pc | PC用 | URL |
| qr | QRコード画像の表示 画像サイズ等の変更方法はこちら |
URL |
| theme | テーマ [複数要素] | |
| code | テーマコード | 000006 |
| name | テーマ名 | 野球観戦 |
| category | テーマカテゴリ | |
| code | テーマカテゴリコード | 001 |
| name | テーマカテゴリ名 | ツアー |
| group | テーマグループ | |
| code | テーマグループコード | G00003 |
| name | テーマグループ名 | スポーツ観戦 |
| osusume | 2010/1/5より、休止となりました。レスポンスされませんのでご了承ください オススメレポート ※ごく一部のプレミアムツアーにのみ追加される情報です。 |
|
| name | オススメ同行者 - 名称 | カップル |
| code | オススメ同行者 - コード値 | 007 |
| report | レポート記事 [複数要素] | |
| title | タイトル文 | クロアチアの海と山の自然と魅力的な街を訪れます |
| img | イメージ画像 ※注意: 1つめの report にのみ含まれます |
|
| caption | 画像キャプション | 城壁より望むドブロブニク旧市街 |
| l | 画像URL - 大サイズ | URL |
| m | 画像URL - 中サイズ | URL |
| s | 画像URL - 小サイズ | URL |
| dest | NEW 目的地 (行き先の代表都市)(destinationの略) | |
| code | 都市コード | C14 |
| name | 都市名 | ナクル |
| lat | 緯度 (世界測地系) *1 | 51.5091700000 |
| lng | 経度 (世界測地系) *1 | -0.1263430000 |
| area | 都市が属するエリア | |
| code | エリアコード | CAF |
| name | エリア名 | アフリカ•他 |
| country | 都市が属する国 | |
| code | 国コード | KE |
| name | 国名 | ケニア |
| kwic | フリーワード検索かつクエリ項目 kwic=1 を有効にした場合のみ KWIC コンテンツを表示します (詳細はこちらを参照) | ...さまざまな <span class="kwic">世界遺産</span> を訪問... |
*1 緯度経度情報が含まれない都市もあります。
サンプルレスポンス
<?xml version="1.0" encoding="UTF-8"?>
<results xmlns="http://webservice.recruit.co.jp/ab-road/">
<api_version>1.00</api_version>
<results_available>39</results_available>
<results_returned>1</results_returned>
<results_start>1</results_start>
<tour>
<id>AB000</id>
<last_update>2007-07-06T19:31:00Z</last_update>
<airline>
<code>00</code>
<name>エービーロード航空</name>
</airline>
<airline_summary>エービーロード航空</airline_summary>
<term>5</term>
<title>華の都パリとブリュッセル２都市訪問 全朝食付 ５日間</title>
<brand>
<code>0000000000</code>
<name>ＡＢトラベル</name>
</brand>
<city_summary>パリ、ブリュッセル</city_summary>
<dept_city>
<code>NRT</code>
<name>成田</name>
</dept_city>
<hotel>
<code />
<name>エービーロード・パリ又は同等クラス</name>
<city>
<code>PAR</code>
<name>パリ</name>
</city>
</hotel>
<hotel>
<code>0000</code>
<name>エービーロード・スクエア･ホテル</name>
<city>
<code>BRU</code>
<name>ブリュッセル</name>
</city>
</hotel>
<hotel_summary>エービーロード・パリ又は同等クラス(パリ)、エービーロード・スクエア･ホテル(ブリュッセル)</hotel_summary>
<kodawari>
<code>1</code>
<name>フリープラン</name>
</kodawari>
<kodawari>
<code>2</code>
<name>午前便</name>
</kodawari>
<kodawari>
<code>10</code>
<name>航空会社指定</name>
</kodawari>
<price>
<all_month>
<max>300000</max>
<min>150000</min>
</all_month>
<max>250000</max>
<min>160000</min>
</price>
<sche>
<day>1</day>
<city>
<code>PAR</code>
<name>パリ</name>
<lat>22.222222</code>
<lng>11.111111</name>
<area>
<code>EUR</code>
<name>ヨーロッパ</name>
</area>
<country>
<code>FR</code>
<name>フランス</name>
</country>
</city>
</sche>
<sche>
<day>2</day>
<city>
<code>BRU</code>
<name>ブリュッセル</name>
<lat>22.222222</code>
<lng>11.111111</name>
<area>
<code>EUR</code>
<name>ヨーロッパ</name>
</area>
<country>
<code>BE</code>
<name>ベルギー</name>
</country>
</city>
</sche>
...宿泊地繰り返し...
<urls>
<mobile>http://www.ab-road.net/</mobile>
<pc>http://www.ab-road.net/</pc>
<qr>http://www.ab-road.net/</qr>
</urls>
<osusume>
... オススメレポート(省略) ...
</osusume>
</tour>
</results>
エリアマスタAPI
国の上位グループである、エリアのマスタを取得します。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xmlまたはjsonまたはjsonp |
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.01 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| area | [複数要素] | |
| code | エリアコード | EUR |
| name | エリア名 | ヨーロッパ |
| tour_count | このエリアに行くツアーの件数 | 37 |
国マスタAPI
エリアごとの国一覧取得や、国名での検索も可能です。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| area | エリアコード | 複数指定可能*2 | (例)EUR | |
| country | 国コード | 複数指定可能*2 | (例)BE | |
| keyword | フリーワード | 文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。複数指定可能*2。 | (例)ベトナム | |
| in_use | ツアー有無 | 1:そこに行くツアーが存在する国のみ返す(デフォルト)。0:ツアーの存在有無に関係なく全件を返す。 | 1:有のみ(デフォルト)、0:全件 | |
| order | ソート順 | 検索結果の並び順を指定します。 | 0:エリアコード＋国名順（デフォルト）、1:国名順、2:ABROAD指定順 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値:10,最小1,最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
name=value1&name=value2&...または name=value1,value2,... (最大20個まで)
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.01 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| country | [複数要素] | |
| code | 国コード | IN |
| name | 国名 | インド |
| name_en | 英語国名(未登録の場合、*が入る場合もあり。) | INDIA |
| tour_count | この国に行くツアーの件数 | 89 |
| area | ||
| code | エリアコード | AAS |
| name | エリア名 | アジア |
都市マスタAPI
国ごとの都市一覧の取得や、都市名の検索が可能です。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| area | エリアコード | 複数指定可能*2 | (例)EUR | |
| country | 国コード | 複数指定可能*2 | (例)BE | |
| city | 都市コード | 複数指定可能*2 | (例)NYC | |
| keyword | フリーワード | 文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。複数指定可能*2。 | (例)ベトナム | |
| in_use | ツアー有無 | 1:そこに行くツアーが存在する都市のみ返す(デフォルト)。0:ツアーの存在有無に関係なく全件を返す。 | 1:有のみ(デフォルト)、0:全件 | |
| order | ソート順 | 検索結果の並び順を指定します。 | 0:エリアコード＋国名＋都市名(デフォルト)、1:国名+都市名順、2:ABROAD指定順 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値:10,最小1,最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
name=value1&name=value2&...または name=value1,value2,... (最大20個まで)
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.01 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| city | [複数要素] | |
| code | 都市コード | ELS |
| name | 都市名 | イーストロンドン |
| name_en | 英語都市名(未登録の場合、*が入る場合もあり。) | EAST LONDON |
| tour_count | この都市に行くツアーの件数 | 120 |
| lat | 緯度 (世界測地系) *1 | 51.5091700000 |
| lng | 経度 (世界測地系) *1 | -0.1263430000 |
| area | ||
| code | エリアコード | CAF |
| name | エリア名 | アフリカ・他 |
| country | ||
| code | 国コード | ZA |
| name | 国名 | 南アフリカ |
| name_en | 英語国名(未登録の場合、*が入る場合もあり。) | SOUTH AFRICA |
*1 緯度経度情報が含まれない都市もあります。
ホテルマスタAPI
都市ごとのホテル一覧取得や、ホテル名での検索が可能です。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| area | エリアコード | 複数指定可能*2 | *1 | (例)EUR |
| country | 国コード | 複数指定可能*2 | *1 | (例)BE |
| city | 都市コード | 複数指定可能*2 | *1 | (例)NYC |
| hotel | ホテルコード | 複数指定可能*2 | *1 | (例)73393 |
| keyword | フリーワード | 文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。複数指定可能*2。 | *1 | (例)グランド |
| in_use | ツアー有無 | 1:ツアーで利用予定のあるホテルのみ返す(デフォルト)。0:利用予定の有無に関係なく全件を返す。※hotelパラメータを指定した場合は自動的に 0 になります。 | 1:有のみ(デフォルト)、0:全件 | |
| order | ソート順 | 検索結果の並び順を指定します。 | 0:ホテル名(デフォルト)1:エリア名＋国名＋都市名＋ホテル名 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値:10,最小1,最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
name=value1&name=value2&...または name=value1,value2,... (最大20個まで)
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.01 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| hotel | [複数要素] | |
| code | ホテルコード | 1234567 |
| name | ホテル名 | グランドロイヤルホテル |
| name_en | 英語ホテル名 | GRAND HOTEL LONDON |
| tour_count | このホテルを利用するツアーの件数 | 120 |
| city | ||
| code | 都市コード | ELS |
| name | 都市名 | イーストロンドン |
| name_en | 英語都市名(未登録の場合、*が入る場合もあり。) | SOUTH AFRICA |
| area | ||
| code | エリアコード | CAF |
| name | エリア名 | アフリカ・他 |
| country | ||
| code | 国コード | ZA |
| name | 国名 | 南アフリカ |
| name_en | 英語国名(未登録の場合、*が入る場合もあり。) | SOUTH AFRICA |
航空会社マスタAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| airline | 航空会社コード | 複数指定可能*2 | (例)XX | |
| keyword | フリーワード | 文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。複数指定可能*2。 | (例)スペイン | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値:10,最小1,最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
name=value1&name=value2&...または name=value1,value2,... (最大20個まで)
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.01 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| airline | [複数要素] | |
| code | 航空会社コード | XX |
| name | 航空会社名（船利用の場合は、「船」になります。） | 世界航空 |
こだわりマスタAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.01 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| kodawari | [複数要素] | |
| code | こだわりコード | 1 |
| name | こだわり名称 | フリープラン |
観光地マスタAPI
AB-ROADに登録されている世界中の観光地を検索できます。国や都市ごとの絞込みが可能です。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| spot | 観光地コード | 複数指定可能*2 | 000921 | |
| area | エリアコード | 複数指定可能*2 | (例)EUR | |
| country | 国コード | 複数指定可能*2 | (例)BE | |
| city | 都市コード | 複数指定可能*2 | (例)NYC | |
| keyword | フリーワード | 文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。複数指定可能*2。 | (例)教会 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値:10,最小1,最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
name=value1&name=value2&...または name=value1,value2,... (最大20個まで)
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.01 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| spot | [複数要素] | |
| code | 観光地コード | 000921 |
| name | 観光地名 | モダーブ城 |
| name_en | 英語観光地名 (一部観光地のみ対応) | MODAVE CASTLE |
| title | タイトル | 断崖に建つ、ルイ14世様式の貴族の館 |
| description | 詳細説明 | 13世紀にオーユ川沿いの60メートルの断崖に... |
| lat | 緯度 (世界測地系) *1 | 50.4703980000 |
| lng | 経度 (世界測地系) *1 | -0.1263430000 |
| map_scale | 地図にプロットする際の表示拡大率の参考値< | 10 (0～10) |
| area | ||
| code | エリアコード | EUR |
| name | エリア名 | ヨーロッパ |
| country | ||
| code | 国コード | BE |
| name | 国名 | ベルギー |
| city | ||
| code | 都市コード | G60 |
| name | 都市名 | ナミュール |
| url | AB-ROAD詳細ページへのURL | http://... |
オススメマスタAPI
2010/1/5より、休止となりました。レスポンスされませんのでご了承ください
海外旅行検索API利用の際、「夫婦にオススメ」「グループにオススメ」等、同行者の選択肢を取得する為のマスタAPIです。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| osusume | オススメコード | 複数指定可能*2 | 007 | |
| dept | 出発地コード | 複数指定可能*2 | TYO:東京 NGO：名古屋 OSA:大阪 FUK:福岡 999:その他 | |
| order | ソート順 | 検索結果の並び順を指定します。 | 0:コード昇順 (デフォルト) 1:該当ツアー件数多い順 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値:10,最小1,最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
name=value1&name=value2&...または name=value1,value2,... (最大20個まで)
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.01 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| osusume | [複数要素] | |
| code | オススメコード | 007 |
| name | オススメ名称 | 夫婦 |
| tour_count | 該当ツアー件数 | 35 |
テーママスタAPI NEW!
それぞれの海外旅行ツアーが持つテーマとそのコード値を取得します。
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| code | テーマコード | それぞれのテーマひとつずつに割り当てられたコード値。複数指定可能*2 | (例) 000003 | |
| group | グループコード | 幾つかの同じ属性を持つテーマをまとめたグループのコード値で、以下の中から指定します。複数指定可能*2 G00001: ダイビング G00002: おけいこ留学 G00003: スポーツ観戦 G00004: スパ･エステ G00005: カップル･夫婦向き G00006: 子連れ旅行向き |
(例) G00004 | |
| category | カテゴリコード | 上記グループコードをさらにグルーピングしたコード値で、以下の中から指定します。複数指定可能*2 001: ツアー (ツアー自体のテーマ) 002: ホテル (宿泊ホテルのテーマ) |
(例) 002 | |
| keyword | フリーワード | 文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。複数指定可能*2。 | (例) ダイビング | |
| in_use | ツアー有無 | 1:該当ツアーが存在するテーマのみ返す(デフォルト)。0:ツアーの存在有無に関係なく全件を返す。 | 1:有のみ(デフォルト)、0:全件 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値:10,最小1,最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
name=value1&name=value2&...または name=value1,value2,... (最大20個まで)
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.01 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| theme | [複数要素] | |
| code | テーマコード | 000006 |
| name | テーマ名 | 野球観戦 |
| tour_count | このテーマを持つツアーの件数 | 120 |
| category | ||
| code | カテゴリコード | 001 |
| name | カテゴリ名 | ツアー |
| group | ||
| code | グループコード | G00003 |
| name | グループ名 | スポーツ観戦 |
キーワード都市集計API
キーワードを元に、そのキーワードにマッチした海外旅行ツアーが訪れる「都市」の集計結果を取得できます。例) "登山" で検索 → 登山に関連するツアーが最も多く含まれる都市を返します: 1.チューリッヒ、2.グリンデルワルト、3.エアーズロック...
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| keyword | キーワード | 文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。複数指定可能*2。 | ○ | (例)登山、聖堂、世界遺産 など |
| dept | 出発地 | ※これらの項目は海外旅行検索APIと同様の指定方法で利用できます。 | ||
| ym | 出発月 | |||
| ymd | 出発日 | |||
| price_min | 価格帯下限 | |||
| price_max | 価格帯上限 | |||
| term_min | 期間下限 | |||
| term_max | 期間上限 | |||
| airline | 航空会社 | |||
| kodaw | こだわり項目 | |||
| axis | 集計軸 | デフォルトは都市(city)で集計されますが、あるいは上位の国(country)やエリア(area)で集計させる事が出来ます。 | city (初期値), country, area | |
| order | ソート順 | 検索結果の並び順を指定します。 | 0: 該当ツアー数多い順 > 都市名順 (デフォルト) 1: 該当ツアー数少ない順 > 都市名順 2: エリアコード > 国名 > 都市名順 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値:10,最小1,最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 | |
name=value1&name=value2&...または name=value1,value2,... (最大20個まで)
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIのバージョン | 1.01 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 7 |
| results_returned | このＸＭＬに含まれる検索結果の件数 | 7 |
| results_start | 検索結果の開始位置 | 1 |
| tour_tally | [複数要素] | |
| type | 集計軸 (検索クエリaxisで指定した値) | city, country, area のいずれか |
| code | 都市コード (↑typeがcountryなら国コード、areaならエリアコード) | ZRH |
| name | 都市名 (↑typeがcountryなら国名、areaならエリア名) | チューリッヒ |
| tour_count | そこに訪れるツアー件数 | 128 |
| lat | 緯度 (世界測地系) *1 | 47.3974200000 |
| lng | 経度 (世界測地系) *1 | 8.5401540000 |
| area | ※↑type=cityまたはcountryの場合のみ含まれます | |
| code | エリアコード | EUR |
| name | エリア名 | ヨーロッパ |
| country | ※↑type=cityの場合のみ含まれます | |
| code | 国コード | CH |
| name | 国名 | スイス |
*1 緯度経度情報が含まれない都市もあります。
エラー時のレスポンス
<?xml version="1.0" encoding="UTF-8"?>
<results xmlns="http://webservice.recruit.co.jp/ab-road/">
<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/ab-road/crossdomain.xml");
このように crossdomain.xml を指定する事で、ご自身のサイト上にある Flash SWF ファイルから、本APIを利用することが可能になります。
