概要
Online Booking API は、ホテル公式サイトの予約エンジンを HMS ホテル管理システムに接続します。客室・料金一覧、カレンダーの空室状況、クーポンの検証、決済ステップ、HMS への予約送信は、すべてこの API を通じて行います。予約エンジンを開発する代理店や HMS パートナー向けに設計されています。
ベース URL#
すべてのエンドポイントは以下のベース URL の /external/… パス配下にあります。HTTPS のみ受け付けます。
https://test.hms.gen.trフローの全体像#
1ログイン
POST /external/public/login2客室と料金
POST /external/online/roomType3決済
POST …/payment/type/{type}4予約
POST …/channel/bookingログインで取得するトークンの有効期間は7日間で、1つのホテルに紐づきます。客室一覧は、ゲストが検索した日付と人数で販売可能な客室と料金を返します。ゲストが客室を選び、支払い方法が確定したら、予約を BookingPushRQ として HMS に書き込みます。各ステップは予約フローガイドで順を追って説明しています。
リソース#
| リソース | エンドポイント |
|---|---|
| 認証 | POST /external/public/login |
| 客室と料金 | POST /external/online/roomTypeGET /external/room/type/hotel/availability |
| 予約 | POST /external/online/channel/booking |
| 決済 | GET /external/online/payment/typeGET /external/payment/companyPOST /external/online/payment/type/{paymentType} |
| クーポン | POST /external/online/coupon/search |
| パッケージとオプション | GET /external/stock/packages |
| ホテル情報 | GET /external/hotel/{hotelID}/contact/infoGET /external/online/social/mediaGET /external/online/footerGET /external/online/mail/host |
| 参照データ | POST /external/countiesGET /external/currenciesGET /external/languages |
共通ルール#
- ログイン以外のすべてのリクエストには
Authorization: Bearer <token>ヘッダーを付けます。 - ほとんどの
POSTエンドポイントはフォームフィールド(application/x-www-form-urlencodedまたはmultipart/form-data)を受け取ります。予約送信と決済開始は JSON ボディを受け取ります。どちらを使うかは各エンドポイントのリファレンスページに記載しています。 - レスポンスは
successフラグを含む JSON です。ビジネスルールのエラーも HTTP200で返るため、結果はステータスコードではなくsuccessで判定してください。 - 日付は
YYYY-MM-DD、金額は小数点以下2桁の文字列("965.00")です。通貨はホテルのオンラインチャネル設定で決まります。 hotelIDパラメーターは、トークンが紐づくホテルと一致している必要があります。
バージョン#
このドキュメントは HMS API V2 を対象としています。新しいフィールドやエンドポイントは予告なく追加されることがあるため、未知のフィールドを無視するようにクライアントを実装してください。変更内容は変更履歴に掲載しています。