概要

Online Booking API は、ホテル公式サイトの予約エンジンを HMS ホテル管理システムに接続します。客室・料金一覧、カレンダーの空室状況、クーポンの検証、決済ステップ、HMS への予約送信は、すべてこの API を通じて行います。予約エンジンを開発する代理店や HMS パートナー向けに設計されています。

ベース URL#

すべてのエンドポイントは以下のベース URL の /external/… パス配下にあります。HTTPS のみ受け付けます。

API ベース URL
https://test.hms.gen.tr

フローの全体像#

1ログインPOST /external/public/login
2客室と料金POST /external/online/roomType
3決済POST …/payment/type/{type}
4予約POST …/channel/booking

ログインで取得するトークンの有効期間は7日間で、1つのホテルに紐づきます。客室一覧は、ゲストが検索した日付と人数で販売可能な客室と料金を返します。ゲストが客室を選び、支払い方法が確定したら、予約を BookingPushRQ として HMS に書き込みます。各ステップは予約フローガイドで順を追って説明しています。

リソース#

リソースエンドポイント
認証POST /external/public/login
客室と料金POST /external/online/roomType
GET /external/room/type/hotel/availability
予約POST /external/online/channel/booking
決済GET /external/online/payment/type
GET /external/payment/company
POST /external/online/payment/type/{paymentType}
クーポンPOST /external/online/coupon/search
パッケージとオプションGET /external/stock/packages
ホテル情報GET /external/hotel/{hotelID}/contact/info
GET /external/online/social/media
GET /external/online/footer
GET /external/online/mail/host
参照データPOST /external/counties
GET /external/currencies
GET /external/languages

共通ルール#

  • ログイン以外のすべてのリクエストには Authorization: Bearer <token> ヘッダーを付けます。
  • ほとんどの POST エンドポイントはフォームフィールド(application/x-www-form-urlencoded または multipart/form-data)を受け取ります。予約送信と決済開始は JSON ボディを受け取ります。どちらを使うかは各エンドポイントのリファレンスページに記載しています。
  • レスポンスは success フラグを含む JSON です。ビジネスルールのエラーも HTTP 200 で返るため、結果はステータスコードではなく success で判定してください。
  • 日付は YYYY-MM-DD、金額は小数点以下2桁の文字列("965.00")です。通貨はホテルのオンラインチャネル設定で決まります。
  • hotelID パラメーターは、トークンが紐づくホテルと一致している必要があります。

バージョン#

このドキュメントは HMS API V2 を対象としています。新しいフィールドやエンドポイントは予告なく追加されることがあるため、未知のフィールドを無視するようにクライアントを実装してください。変更内容は変更履歴に掲載しています。

次のステップ#