リクエストURL（REST／JSON形式の場合）

http://api.rakuten.co.jp/rws/3.0/rest?[parameter]=[value]…
http://api.rakuten.co.jp/rws/3.0/json?[parameter]=[value]…

※JSONP形式は、JSON形式で入力パラメーターにcallBackを指定することで出力されます。

たとえば、施設番号が123456の施設の詳細情報を取得する場合のリクエストURLは下記になります。（実際には改行せずに1行につなげてリクエストしてください。）

SOAPについて

SOAPを用いることで、より高度なアプリケーションの開発が可能となります。
SOAPに関しての詳細は「楽天トラベル施設検索API(SimpleHotelSearch)SOAP開発用」をご覧ください。

入力パラメーター

楽天トラベル施設情報API（HotelDetailSearch) 入力パラメーター version:2009-09-09

ID	項目名	パラメーター	型(括弧内は最大バイト数)	必須	デフォルト	備考
区分:共通パラメーター
1	デベロッパID	developerId	String		-	デベロッパーID（こちらで確認できるアプリケーションIDのことです）
2	アフィリエイトID	affiliateId	String	-	指定無し	アフィリエイトID
3	操作	operation	String		-	使用するAPIの操作名：HotelDetailSearch
4	コールバック関数名	callBack	String	-	指定無し	JSONPとして出力する際のコールバック関数名 （UTF-8でURLエンコードした文字列） 英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上
区分:サービス固有パラメーター
1	バージョン	version	String		-	2009-09-09
2	施設番号	hotelNo	int(10)		-	楽天トラベルにおける施設を特定するためのNo
3	キャリア情報	carrier	int(1)	-	0	PC用の情報を返すのか、モバイル用の情報を返すのかを選択 0:PC 1:mobile
4	緯度経度タイプ	datumType	int(1)	-	2	出力パラメータの緯度経度タイプを指定する。 1：世界測地系、単位は度。 2：日本測地系、単位は秒。
5	施設画像サイズ【NEW】	hotelThumbnailSize	int(1)	-	2	出力パラメータの施設画像サムネイルURLの画像サイズを指定する。 1：小 2：中 3：大
6	返却情報タイプ【NEW】	responseType	int(1)	-	middle	出力パラメータの返却情報タイプを指定する。 small:最低限の情報のみ middle:中くらい large:すべての情報

出力パラメーター

楽天トラベル施設検索API（SimpleHotelSearch) 出力パラメーター version:2009-10-20

ID	分類	small	middle	large	項目名	パラメーター	備考
区分:共通パラメーター
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	施設基本情報 hotelBasicInfo				施設番号	hotelNo
2					施設名称	hotelName
3					施設情報ページURL	hotelInformationUrl	入力パラメーターにアフィリエイトIDが含まれていた場合、 アフィリエイトURLとなります。(*1) (*1)carrierがモバイルの場合、 ダイナミックパッケージ宿泊プラン一覧ページは 日付を御入力頂いた後にプラン一覧が出力されます。
4					宿泊プラン一覧ページURL	planListUrl
5					ダイナミックパッケージ 宿泊プラン一覧ページURL	dpPlanListUrl
6					お客様の声ページURL	reviewUrl
7					施設かな名称	hotelKanaName
8					施設特色	hotelSpecial
9					最安料金	hotelMinCharge	1部屋1泊あたり、税・サービス料込みの最安値の目安
10					緯度	latitude	datumType=1の場合：世界測地系（WGS）、単位は度 datumType=2の場合：日本測地系（Tokyo Datum）、単位は秒、小数点以下がミリ秒
11					経度	longitude	datumType=1の場合：世界測地系（WGS）、単位は度 datumType=2の場合：日本測地系（Tokyo Datum）、単位は秒、小数点以下がミリ秒
12					郵便番号	postalCode
13					住所１	address1
14					住所２	address2
15					施設電話番号	telephoneNo
16					ファックス番号	faxNo
17					施設へのアクセス	access
18					駐車場情報	parkingInformation
19					最寄駅名称	nearestStation
20					施設画像URL	hotelImageUrl
21					施設画像サムネイルURL	hotelThumbnailUrl
22					部屋画像URL	roomImageUrl
23					部屋画像サムネイルURL	roomThumbnailUrl
24					施設提供地図画像URL	hotelMapImageUrl
25					投稿件数	reviewCount
26					★の数（総合）	reviewAverage	★の見方について
27					お客さまの声（1件目）	userReview	お客さまの声の最新の１件目を表示します。
28	評価詳細情報 hotelRatingInfo	－			★の数（サービス）	serviceAverage	★の見方について
29					★の数（立地）	locationAverage
30					★の数（部屋）	roomAverage
31					★の数（設備・アメニティ）	equipmentAverage
32					★の数（風呂）	bathAverage
33					★の数（食事）	mealAverage
34	施設詳細情報 hotelDetailInfo	－	－		宿泊予約センター電話番号	reserveTelephoneNo	楽天価格での予約が電話で可能です。
35					中区分コード	middleClassCode	都道府県などを示すコード。 コード一覧は地区コードAPI（GetAreaClass) より取得してください。
36					小区分コード	smallClassCode	都道府県などを示すコード。 コード一覧は地区コードAPI（GetAreaClass) より取得してください。
37					地区名	areaName
38					ホテル種別コード	hotelClassCode
39					チェックイン時刻	checkinTime	HH:MM
40					チェックアウト時刻	checkoutTime	HH:MM
41					最終チェックイン時刻	lastCheckinTime	HH:MM
42	設備情報 hotelFacilitiesInfo	－	－		部屋数	hotelRoomNum
43					部屋設備・備品	roomFacilities
44					> 項目名	item
45					館内設備	hotelFacilities
46					> 項目名	item
47					食事場所について	aboutMealPlace
48					> 朝食	breakfastPlace
49					> 夕食	dinnerPlace
50					風呂について	aboutBath
51					> 種類	bathType
52					> 泉質	bathQuality
53					> 効能	bathBenefits
54					周辺のレジャーについて	aboutLeisure
55					身障者設備	handicappedFacilities
56					> 項目名	item
57					スタッフの言語レベルについて	linguisticLevel
58	宿泊条件・決済関連 hotelPolicyInfo	－	－		条件・注意事項・備考	note
59					キャンセルポリシー	cancelPolicy
60					使用可能なカード	availableCreditCard
61					> カード	card
62					カード利用についての注意事項	aboutCreditCardNote
63					ポイント加算について	aboutPointAdd	楽天スーパーポイント以外のポイントサービスについての情報
64					マイレージ加算について	aboutMileageAdd
65	特典・その他 hotelOtherInfo	－	－		特典	privilege
66					その他情報	otherInformation

アフィリエイトに関して

デベロッパーは、楽天トラベル施設情報APIから取得した商品情報からアフィリエイトURLを作成することが可能です。リンク先にそのアフィリエイトURLを指定することで、楽天アフィリエイト経由の成果報酬を獲得することができます。
アフィリエイトURLを作るには、APIの入力パラメーターに「アフィリエイトID」を含めてリクエストしてください。APIの出力に「アフィリエイトURL」が含まれます。
入力パラメーターcarrierでPCが指定された場合でもモバイルが指定された場合でも同様の方法でアフィリエイトURLを作成することができます。（2008年11月現在）

エラー

エラーが起こった際は、出力中の「共通パラメーター」のStatusに下表に記載されたいずれかが表示されます。

Statusでの表示	内容
NotFound	検索結果が存在しない。
ServerError	楽天ウェブサービス側のエラー。
ClientError	デベロッパーの入力に起因するエラー。
Maintenance	メンテナンス。

過去のバージョン

本APIの過去のバージョンは下記からご覧いただけます。