概要

Hotspot API は、滞在中のゲスト一覧をホットスポット（キャプティブポータル）システムに提供します。チェックイン済みでまだチェックアウトしていないすべてのゲストについて、HMS は部屋番号、氏名、ID 番号、生年月日、チェックイン／チェックアウト日時を返します。ホットスポットソフトウェアはこの一覧を使って、部屋番号と姓によるゲストの Wi-Fi ログインを認証し、滞在終了時にアクセスを停止し、トルコ法第5651号に基づいて保存するアクセスログを本人の身元と紐づけます。

ベース URL#

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

https://test.hms.gen.tr

フローの概要#

キーはホテルの HMS 管理パネルで一度だけ発行し、すべてのリクエストで ApiKey ヘッダーとして送信します。一覧エンドポイントは、滞在中のすべてのゲストを1回の呼び出しで返します。ホットスポットソフトウェアは、ゲストがポータルで入力した部屋番号と姓をこの一覧と照合し、チェックアウト予定日までアカウントを有効にします。また、一覧を定期的に更新して、退館したゲストのアカウントを停止します。詳しくはゲスト認証フローガイドを参照してください。

リソース#

共通ルール#

• すべてのリクエストに ApiKey ヘッダーを付けます。ログインの手順やトークンはありません。
• エンドポイントは POST で呼び出します。ボディ、クエリ文字列、絞り込みパラメーターはありません。
• レスポンスは JSON で、success フィールドは数値の 1 または 0 です。認証に失敗すると、HTTP 401 で {"success": 0} が返ります。
• 日時は Unix タイムスタンプ（秒）です。生年月日は DD.MM.YYYY 形式の文字列です。
• 一覧はホテル全体を対象とし、部屋や日付による絞り込みはありません。照合は自社側で行い、一覧をキャッシュしてください。
• レスポンスには個人データ（ID 番号、生年月日）が含まれます。必要なフィールドのみを保存し、リクエストはゲストの端末からではなく、必ず自社のサーバーから送信してください。

バージョン管理#

このエンドポイントは HMS のカスタム API グループに属し、バージョン番号はありません。新しいフィールドは予告なく追加されることがあるため、未知のフィールドを無視するようにクライアントを実装してください。既存フィールドの削除や意味の変更は、変更履歴で事前にお知らせします。

次のステップ#