楽天トラベル施設検索API リクエストの作成

リクエストURLの作成

基本URLに検索したいパラメータを追加していけば、URLを作成することができます。作成したURLをブラウザに入力すれば応答が返ってくるので、正常に動作しているか確認することができます。
関連ページ XML構造
エリア検索サンプルコード 位置と範囲検索サンプルコード 施設番号検索サンプルコード

エリアで検索する場合のリクエストURL

エリア区分を指定して検索します。長野県の白樺湖・車山・蓼科・霧ヶ峰を指定しています。
大区分(largeClassCode):japan
中区分(middleClassCode):nagano
小区分(smallClassCode):kirigamine
地区コードは、地区コードの一覧を参照下さい。 楽天トラベル地区コードAPIを使用
エリア検索全体のサンプルコードはこちら

http://api.rakuten.co.jp/rws/1.12/rest?
developerId=★★&affiliateId=◆◆
&operation=SimpleHotelSearch&version=2008-11-13
&largeClassCode=japan
&middleClassCode=nagano
&smallClassCode=kirigamine

★★にはデベロッパーIDを、◆◆には、アフィリエイトIDを入れます。
サンプルURLは改行されていますが、実際には改行せずに使用します。
リクエストURLをブラウザに入力し、エラーなどが表示されなければ、OKです。

位置と範囲で検索する場合のリクエストURL

位置と範囲を指定して検索します。上諏訪駅の緯度(latitude)と経度(longitude)、そこからの半径(searchRadius)を指定しています。datumType=1で、世界測地系を指定しています。単位は度。日本測地系の場合は、datumType=2とし、単位は秒。 単位の計算
位置と範囲検索全体のサンプルコードはこちら

http://api.rakuten.co.jp/rws/1.12/rest?
developerId=★★affiliateId=◆◆
&operation=SimpleHotelSearch&version=2008-11-13
&latitude=36.046757
&longitude=138.116461
&searchRadius=3
&datumType=1

★★にはデベロッパーIDを、◆◆には、アフィリエイトIDを入れます。
サンプルURLは改行されていますが、実際には改行せずに使用します。
リクエストURLをブラウザに入力し、エラーなどが表示されなければ、OKです。

施設番号で検索する場合のリクエストURL

施設固有の施設番号で検索します。hotelNoに、池の平ホテル(29350)コロシアム・イン・蓼科(2175)スカイパークホテル(2111)の施設番号を指定しています。複数指定する場合は、「,」を使用します。施設番号は、楽天トラベルのURLに含まれていますので、上記のリンクで確認下さい。
施設番号検索全体のサンプルコードはこちら

http://api.rakuten.co.jp/rws/1.12/rest?
developerId=★★&affiliateId=◆◆
&operation=SimpleHotelSearch&version=2008-11-13
&hotelNo=29350,2175,2111

★★にはデベロッパーIDを、◆◆には、アフィリエイトIDを入れます。
サンプルURLは改行されていますが、実際には改行せずに使用します。
リクエストURLをブラウザに入力し、エラーなどが表示されなければ、OKです。

リクエストURL作成時の注意点

  • リクエストには、施設番号、緯度経度、区分コードのいずれかを指定する必要があります。
  • 施設番号、緯度経度、区分コードを複数指定した場合は、この順序で優先されます。
  • 区分コードの指定では、上位の区分コードを省略することはできません。
    中区分(middleClassCode)を指定する場合は、大区分(largeClassCode)の指定も必要です。

アフィリエイトID

アフィリエイトIDについては、アフィリエイトIDの説明を参照下さい。

リクエストパラメータ

リクエストパラメータの一覧です。ここからのコピー
コードに関しては、サンプルコードで説明しています。

楽天トラベル施設検索API(SimpleHotelSearch) 入力パラメーター version:2008-11-13
区分 ID 項目名 フィールド名
(括弧内は
最大
バイト数)
必須 デフォルト 備考





|

|
1 デベロッパID developerId String --- デベロッパーID
2 アフィリエイトID affiliateId String - 指定無し アフィリエイトID
3 操作 operation String --- 使用するAPIの操作名:SimpleHotelSearch
4 コールバック関数名 callBack String - 指定無し JSONPとして出力する際のコールバック関数名
(UTF-8でURLエンコードした文字列)
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上

|







|

|
1 バージョン version String --- 2008-11-13
2 大区分コード largeClassCode String
(*1)
(*2)
--- 国などを示すコード。地区コード一覧は地区コードAPI(GetAreaClass) より取得してください。
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。
(*2)地区コード一覧において子の区分が存在する場合、必ず子の区分まで指定する必要があります。
3 中区分コード middleClassCode String
(*1)
(*2)
--- 都道府県などを示すコード。コード一覧は地区コードAPI(GetAreaClass) より取得してください。
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。
(*2)地区コード一覧において子の区分が存在する場合、必ず子の区分まで指定する必要があります。
4 小区分コード smallClassCode String
(*1)
(*2)
--- 市など示すコード。コード一覧は地区コードAPI(GetAreaClass) より取得してください。
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。
(*2)地区コード一覧において子の区分が存在する場合、必ず子の区分まで指定する必要があります。
5 細区分コード detailClassCode String
(*1)
(*2)
--- 駅や詳細地域などを示すコード。コード一覧は地区コードAPI(GetAreaClass) より取得してください。
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。
(*2)地区コード一覧において子の区分が存在する場合、必ず子の区分まで指定する必要があります。
6 施設番号 hotelNo int(10)
(*1)
--- 楽天トラベルにおける施設を特定するためのNo
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。

このフィールドは複数指定することができます。
例)&hotelNo=12345,54321
7 緯度 latitude decimal
(*1)
--- 日本測地系(Tokyo Datum)、単位は秒、ミリ秒は小数点以下2桁以内で指定すること。
例)128216.17
ただし、datumTypeに1を指定した場合は、
世界測地系、単位は度で指定すること。
例)35.6065914
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。
8 経度 longitude decimal
(*1)
--- 日本測地系(Tokyo Datum)、単位は秒、ミリ秒は小数点以下2桁以内で指定すること。
例)503259.29
ただし、datumTypeに1を指定した場合は、
世界測地系、単位は度で指定すること。
例)139.7513225
(*1)区分コード、施設番号、緯度経度いずれかが指定されていることが必須です。複数指定された場合の優先順位は[施設番号>緯度経度>区分コード]となります。
9 検索半径 searchRadius int - 1 緯度経度検索時の検索半径(単位km)
0.1以上、3.0以下であり、小数点以下は1桁までであること
10 絞込み条件 squeezeCondition String - --- kinen:禁煙ルーム internet:インターネットが出来る部屋
daiyoku:大浴場あり onsen:温泉


このフィールドは複数指定することができます。
例)禁煙ルームのある温泉宿
&squeezeCondition=kinen,onsen
11 キャリア情報 carrier int(1) - 0 PC用の情報を返すのか、モバイル用の情報を返すのかを選択
PC:0
mobile:1
12 取得件数 hits long - --- 取得件数を制限するパラメーター。
緯度経度での検索のみに適用し、指定された座標から近い順にソートした結果を返す。
13 緯度経度タイプ datumType int(1) - 2 APIで扱う(入力及び出力)緯度経度のタイプを指定する。
1:世界測地系、単位は度。
2:日本測地系、単位は秒。デフォルト値。
ホームページ WEBサービス API PHP プログラミング