滞在中のゲスト

Hotspot 連携で唯一のリソースです。現在滞在中（チェックイン済みで、まだチェックアウトしていない）のすべてのゲストについて、部屋、身元、チェックイン／チェックアウトの情報を返します。ホットスポットソフトウェアはこの一覧を定期的に取得し、それに応じて Wi-Fi アカウントを有効化・停止します。手順はゲスト認証フローガイドで説明しています。

POST/public/json/customer/inhotel滞在中のゲスト一覧

オブジェクト#

フィールド

uniqueinteger
滞在レコード ID。ゲストと予約ごとに一意です。ホットスポット側のユーザー／セッションのキーとして使用してください。
rezervasyon_idinteger
予約 ID。同室のゲストは同じ値を共有します。
inHotelinteger
1 = ゲストが滞在中。このエンドポイントは滞在中のゲストのみを返すため、常に 1 です。
firstNamestring
名。身分証明書から読み取るため通常は大文字で、複数の名はスペースで区切られます。
lastNamestring
姓。通常は大文字です。
identityNumberstring | null
書類に記載されたトルコ国民 ID 番号またはパスポート番号。身分証情報なしで登録されたゲストでは空の場合があります。
birthDatestring | null
生年月日（DD.MM.YYYY）。空の場合があります。
roomIDinteger
客室の HMS ID。
roomNamestring
ゲストがドアやカードキーで目にする部屋名／部屋番号。ポータルでは「部屋番号」としてこの値の入力を求めてください。
checkininteger
ゲストのチェックイン日時（Unix タイムスタンプ、秒）。
checkoutinteger
チェックアウト予定日。その日の開始時刻（00:00 UTC）を表す Unix タイムスタンプで、時刻情報は含みません。セッションの終了時刻は、ホテルのチェックアウト時刻（通常は12:00）を加算して求めてください。
checkout2integer | null
実際のチェックアウト日時。滞在中のゲストでは null です。チェックアウトしたゲストはいずれにせよ一覧から外れます。
mikrotikSifrelemeinteger
HMS で設定された、客室のある建物の Mikrotik 暗号化設定：0 部屋名（Wi-Fi パスワードは部屋番号）、1 パスワードなし。自社のポータルでも同じポリシーを適用してください。
01
オブジェクトのサンプル
{
    "mikrotikSifreleme": 0,
    "unique": 58211,
    "inHotel": 1,
    "identityNumber": "11111111110",
    "firstName": "AYŞE",
    "lastName": "DEMİR",
    "birthDate": "14.03.1985",
    "roomID": 4,
    "roomName": "104",
    "checkin": 1788863400,
    "checkout": 1788998400,
    "checkout2": null,
    "rezervasyon_id": 282799
}

滞在中のゲスト一覧#

POST/public/json/customer/inhotel

認証: ApiKey ヘッダー

滞在中のゲストの全件リストを返します。絞り込みパラメーターやリクエストボディはありません。予約が有効で、チェックイン済みかつ未チェックアウトであり、ゲストに「滞在中」のフラグが付いている場合に一覧に含まれます。同じ予約のゲストはそれぞれ個別のレコードになります。

レスポンスはページ分割されません。大規模なホテルでは数百件のレコードが返ることもあります。一覧をキャッシュし、推奨間隔で更新してください。

ヘッダー

ApiKeystring必須
HMS の管理パネルで発行するカスタム API キー。1つのホテルに紐づいており、どのホテルのゲストを返すかはこのキーで決まります。
HotelCodeinteger
ホテルの HMS ID。サーバーはキーからホテルを特定するため検証には使用されませんが、ログ記録と互換性のために送信を推奨します。

レスポンス

200 success: 1 と otelde 配列。滞在中のゲストがいない場合、配列は空になります。これはエラーではありません。

successinteger
1 成功、0 失敗。Online Booking とは異なり、真偽値ではなく数値です。
otelde[]object[]
ゲストレコード。フィールドについては上のオブジェクトセクションを参照してください。

エラーレスポンス

  • 401 ApiKey ヘッダーがない、空、または HMS に登録されていない（削除された可能性があります）。ボディ：{"success": 0}。
  • 405 POST 以外のメソッドでリクエストが送信された（例：ブラウザーのアドレスバーからの GET）。
リクエスト
curl -X POST "https://test.hms.gen.tr/public/json/customer/inhotel" \
  -H "ApiKey: $HMS_API_KEY" \
  -H "HotelCode: 1000"
レスポンス · 200
{
    "success": 1,
    "otelde": [
        {
            "mikrotikSifreleme": 0,
            "unique": 58211,
            "inHotel": 1,
            "identityNumber": "11111111110",
            "firstName": "AYŞE",
            "lastName": "DEMİR",
            "birthDate": "14.03.1985",
            "roomID": 4,
            "roomName": "104",
            "checkin": 1788863400,
            "checkout": 1788998400,
            "checkout2": null,
            "rezervasyon_id": 282799
        },
        {
            "mikrotikSifreleme": 0,
            "unique": 58212,
            "inHotel": 1,
            "identityNumber": "22222222220",
            "firstName": "MEHMET",
            "lastName": "DEMİR",
            "birthDate": "02.11.1982",
            "roomID": 4,
            "roomName": "104",
            "checkin": 1788863400,
            "checkout": 1788998400,
            "checkout2": null,
            "rezervasyon_id": 282799
        },
        {
            "mikrotikSifreleme": 0,
            "unique": 58197,
            "inHotel": 1,
            "identityNumber": "U01234567",
            "firstName": "JULIA",
            "lastName": "WAGNER",
            "birthDate": "27.06.1990",
            "roomID": 12,
            "roomName": "205",
            "checkin": 1788782700,
            "checkout": 1789084800,
            "checkout2": null,
            "rezervasyon_id": 282803
        }
    ]
}
レスポンス · 200（滞在中のゲストなし）
{
    "success": 1,
    "otelde": []
}
レスポンス · 401（無効なキー）
{
    "success": 0
}
最終更新: 2026年9月21日誤りを見つけましたか？お知らせください