Гості в готелі

Єдиний ресурс інтеграції з hotspot. Повертає номер, особисті дані та час заїзду й виїзду для кожного гостя, який зараз проживає в готелі (заселений і ще не виселений). Програма hotspot регулярно отримує цей список і відповідно відкриває або закриває облікові записи Wi-Fi; кроки описано в посібнику Процес перевірки гостей.

Об’єкт#

Поля

uniqueinteger
Ідентифікатор запису про проживання, унікальний для кожного гостя й бронювання. Використовуйте його як ключ користувача / сеансу на боці hotspot.
rezervasyon_idinteger
Ідентифікатор бронювання. У гостей, які проживають в одному номері, це значення однакове.
inHotelinteger
1 = гість проживає в готелі. Завжди 1, оскільки ендпоінт повертає лише гостей, які зараз у готелі.
firstNamestring
Ім’я. Зазвичай великими літерами, як зчитано з документа, що посвідчує особу; кілька імен розділено пробілами.
lastNamestring
Прізвище. Зазвичай великими літерами.
identityNumberstring | null
Турецький національний ідентифікаційний номер або номер паспорта в тому вигляді, як він указаний у документі. Може бути порожнім для гостей, зареєстрованих без даних документа.
birthDatestring | null
Дата народження, DD.MM.YYYY. Може бути порожньою.
roomIDinteger
Ідентифікатор номера в HMS.
roomNamestring
Назва або номер кімнати, які гість бачить на дверях і ключ-картці. Саме це значення запитуйте на порталі як «номер кімнати».
checkininteger
Час заселення гостя як мітка часу Unix (у секундах).
checkoutinteger
Запланована дата виїзду як мітка часу Unix на початок доби (00:00 UTC); часу доби вона не містить. Щоб отримати кінець сеансу, додайте розрахунковий час готелю (зазвичай 12:00).
checkout2integer | null
Фактичний час виїзду. Для гостей, які проживають у готелі, — null; гість, який виїхав, однаково зникає зі списку.
mikrotikSifrelemeinteger
Налаштування шифрування Mikrotik у HMS для корпусу, де розташований номер: 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обов’язковий
Власний API-ключ, створений у панелі адміністратора HMS. Він прив’язаний до одного готелю, і саме від нього залежить, чиїх гостей буде показано.
HotelCodeinteger
Ідентифікатор готелю в HMS. Для перевірки не використовується, оскільки сервер визначає готель за ключем; рекомендовано надсилати для журналювання й сумісності.

Відповідь

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
}
Останнє оновлення: 21 вересня 2026 р.Знайшли помилку? Повідомте нам