Online Booking API

公開中HMS API V2予約エンジン API

ホテル公式サイトの予約エンジンを HMS に接続します。客室・料金一覧、カレンダーの空室状況、クーポン、決済、予約送信に対応します。

ベース URL
https://test.hms.gen.tr
認証
apiKey / apiSecret → Bearer トークン
形式
JSON レスポンス · フォームまたは JSON のリクエストボディ
対象範囲
リソース 8 件 · エンドポイント 16 件

リソース#

認証

エンドポイント 1 件

Online Booking API へのアクセスには、HMS が発行するパートナー認証情報を使用します。ログインエンドポイントは apiKey と apiSecret と引き換えにトークンを発行します。以降のすべてのリクエストでは、このトークンを Authorization: Bearer として…

  • POST/external/public/login

客室と料金

エンドポイント 2 件

予約エンジンの検索結果を支える2つのエンドポイントです。指定した日付と人数で販売可能な客室タイプ、食事条件、料金を返す客室一覧と、カレンダー表示用に日ごとの空室状況と料金を返す空室状況があります。

  • POST/external/online/roomType
  • GET/external/room/type/hotel/availability

予約

エンドポイント 1 件

ゲストが選択した客室、食事条件、料金は、BookingPushRQ 構造で HMS に送信されます。同じエンドポイントで type に Cancel または Modify を指定すると、キャンセルや変更も行えます。全体の流れは予約フローガイドを参照してください。

  • POST/external/online/channel/booking

決済

エンドポイント 3 件

ホテルがオンライン予約で受け付ける支払い方法を一覧表示し、選択された方法に応じて決済ステップを開始します。方法ごとの処理は決済フローガイドで説明しています。

  • GET/external/online/payment/type
  • GET/external/payment/company
  • POST/external/online/payment/type/{paymentType}

クーポン

エンドポイント 1 件

ホテルが管理パネルで設定したオンライン割引クーポンを検証します。割引は自社側で適用し、予約送信時には割引後の金額を送信してください。

  • POST/external/online/coupon/search

パッケージとオプション

エンドポイント 1 件

予約と一緒に販売できるオプションです。客室パッケージ(客室タイプに紐づく)と一般パッケージ(送迎、夕食、スパなど)があります。販売したパッケージは予約送信時に extras[] として送信します。

  • GET/external/stock/packages

ホテル情報

エンドポイント 4 件

予約エンジンのページの枠組みを構成するデータです。連絡先と所在地、ソーシャルメディアのリンク、フッターのテキスト(法的表記、ホテル紹介、アナリティクス/広告用スニペット)、予約確認メール用の SMTP 設定が含まれます。

  • GET/external/hotel/{hotelID}/contact/info
  • GET/external/online/social/media
  • GET/external/online/footer
  • ほか 1 件

参照データ

エンドポイント 3 件

フォームの選択肢に使う静的リスト(国、通貨、言語)です。変更はまれなため、1日キャッシュできます。

  • POST/external/counties
  • GET/external/currencies
  • GET/external/languages

ドキュメント#

はじめに

ガイド