|
楽天トラベル施設情報APIとは
■リクエストURL(REST/JSON形式の場合)
http://api.rakuten.co.jp/rws/2.0/rest?[parameter]=[value]…
http://api.rakuten.co.jp/rws/2.0/json?[parameter]=[value]…
※JSONP形式は、JSON形式で入力パラメーターにcallBackを指定することで出力されます。
たとえば、施設番号が123456の施設の詳細情報を取得する場合のリクエストURLは下記になります。(実際には改行せずに1行につなげてリクエストしてください。)
http://api.rakuten.co.jp/rws/2.0/rest?
developerId=[YOUR_developerID]
&operation=HotelDetailSearch
&version=2009-03-26
&hotelNo=123456
| ※ |
短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。 |
■SOAPについて
■入力パラメーター
| 楽天トラベル施設情報API(HotelDetailSearch) 入力パラメーター version:2009-03-26 |
| 区分 |
ID |
項目名 |
フィールド名 |
型
(括弧内は
最大
バイト数) |
必須 |
デフォルト |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
デベロッパID |
developerId |
String |
○ |
--- |
デベロッパーID |
| 2 |
アフィリエイトID |
affiliateId |
String |
- |
指定無し |
アフィリエイトID |
| 3 |
操作 |
operation |
String |
○ |
--- |
使用するAPIの操作名:HotelDetailSearch |
| 4 |
コールバック関数名 |
callBack |
String |
- |
指定無し |
JSONPとして出力する際のコールバック関数名
(UTF-8でURLエンコードした文字列)
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
バージョン |
version |
String |
○ |
--- |
2009-03-26 |
| 2 |
施設番号 |
hotelNo |
int(10) |
○ |
--- |
楽天トラベルにおける施設を特定するためのNo |
| 3 |
キャリア情報 |
carrier |
int(1) |
- |
0 |
PC用の情報を返すのか、モバイル用の情報を返すのかを選択
PC:0
mobile:1 |
| 4 |
緯度経度タイプ |
datumType |
int(1) |
- |
2 |
APIで扱う(入力及び出力)緯度経度のタイプを指定する。
1:世界測地系、単位は度。
2:日本測地系、単位は秒。デフォルト値。 |
|
■出力パラメーター
| 楽天トラベル施設情報API(HotelDetailSearch) 出力パラメーター version:2009-03-26 |
| 区分 |
ID |
分類 |
項目名 |
フィールド名 |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
Arg |
--- |
User-Agent |
Valueにはユーザのユーザエージェントが表示される |
| 2 |
--- |
developerId |
ValueにはデベロッパーIDが表示される |
| 3 |
--- |
affiliateId |
Valueにはユーザの指定したアフィリエイトIDが表示される |
| 4 |
--- |
operation |
Valueにはユーザの指定した操作名が表示される |
| 5 |
--- |
version |
Valueにはユーザの指定した操作のバージョンが表示される |
| 6 |
Status |
--- |
Status |
Success / NotFound / ServerError / ClientError / Maintenance のいずれか |
| 7 |
StatusMsg |
--- |
StatusMsg |
Statusに特化したメッセージを出力 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
施設情報 |
施設番号 |
hotelNo |
|
| 2 |
施設名称 |
hotelName |
|
| 3 |
郵便番号 |
postalCode |
|
| 4 |
住所1 |
address1 |
|
| 5 |
住所2 |
address2 |
|
| 6 |
施設電話番号 |
telephoneNo |
|
| 7 |
ファックス番号 |
faxNo |
|
| 8 |
チェックイン時刻 |
checkinTime |
HH:MM |
| 9 |
最終チェックイン時刻 |
lastCheckinTime |
HH:MM |
| 10 |
チェックアウト時刻 |
checkoutTime |
HH:MM |
| 11 |
緯度 |
latitude |
datumType=1の場合:世界測地系(WGS)、単位は度
datumType=2の場合:日本測地系(Tokyo Datum)、単位は秒、小数点以下がミリ秒 |
| 12 |
経度 |
longitude |
datumType=1の場合:世界測地系(WGS)、単位は度
datumType=2の場合:日本測地系(Tokyo Datum)、単位は秒、小数点以下がミリ秒 |
| 13 |
施設へのアクセス |
access |
|
| 14 |
駐車場情報 |
parkingInformation |
|
| 15 |
施設特色 |
hotelSpecial |
|
| 16 |
部屋設備・備品 |
roomFixture |
|
| 17 |
館内設備 |
hotelFixture |
|
| 18 |
特典 |
privilege |
|
| 19 |
ポイント加算について |
aboutPointAdd |
|
| 20 |
マイレージ加算について |
aboutMileageAdd |
|
| 21 |
食事場所について |
aboutMealPlace |
|
| 22 |
風呂について |
aboutBath |
|
| 23 |
使用可能なカード |
availableCreditCard |
|
| 24 |
カード利用について |
aboutCreditCardNote |
|
| 25 |
周辺のレジャーについて |
aboutLeisure |
|
| 26 |
条件・注意事項・備考 |
note |
|
| 27 |
キャンセルポリシー |
cancelPolicy |
|
| 28 |
海外施設の言語レベルについて |
linguisticLevel |
|
| 29 |
身障者設備 |
handicappedFixture |
|
| 30 |
その他情報 |
otherInformation |
|
| 31 |
施設画像URL |
hotelImageUrl |
|
| 32 |
部屋画像URL |
roomImageUrl |
|
| 33 |
施設提供地図画像URL |
hotelMapImageUrl |
|
| 34 |
施設情報ページURL |
hotelInformationUrl |
|
| 35 |
施設情報ページアフィリエイトURL |
hotelAffiliateUrl |
(入力パラメーターにアフィリエイトIDが含まれていた時のみ) |
| 36 |
宿泊予約センター電話番号 |
reserveTelephoneNo |
楽天価格での予約が電話で可能です。 |
| 37 |
投稿件数【NEW】 |
reviewCount |
|
| 38 |
★の数(総合)【NEW】 |
reviewAverage |
★の見方について(http://travel.rakuten.co.jp/share/toukou/explain_ws.html) |
| 39 |
★の数(サービス)【NEW】 |
serviceAverage |
| 40 |
★の数(立地)【NEW】 |
locationAverage |
| 41 |
★の数(部屋)【NEW】 |
roomAverage |
| 42 |
★の数(設備・アメニティ)【NEW】 |
equipmentAverage |
| 43 |
★の数(風呂)【NEW】 |
bathAverage |
| 44 |
★の数(食事)【NEW】 |
mealAverage |
|
■アフィリエイトに関して
デベロッパーは、楽天トラベル施設情報APIからアフィリエイトURLを取得することが可能です。リンク先にそのアフィリエイトURLを指定することで、楽天アフィリエイト経由の成果報酬を獲得することができます。
アフィリエイトURLを作るには、APIの入力パラメーターに「アフィリエイトID」を含めてリクエストしてください。APIの出力に「アフィリエイトURL」が含まれます。
入力パラメーターcarrierでPCが指定された場合でもモバイルが指定された場合でも同様の方法でアフィリエイトURLを作成することができます。(2008年11月現在)
■エラー
エラーが起こった際は、出力中の「共通パラメーター」のStatusに下表に記載されたいずれかが表示されます。
| Statusでの表示 |
内容 |
| NotFound |
検索結果が存在しない。 |
| ServerError |
楽天ウェブサービス側のエラー。 |
| ClientError |
デベロッパーの入力に起因するエラー。 |
| Maintenance |
メンテナンス。 |
|
■過去のバージョン
本APIの過去のバージョンは下記からご覧いただけます。
|