Проживающие гости

Единственный ресурс интеграции Hotspot. Возвращает номер, личные данные и время заезда и выезда для каждого гостя, который сейчас проживает в отеле (заселён и ещё не выехал). ПО хотспота регулярно запрашивает этот список и по нему открывает и закрывает учётные записи Wi-Fi; шаги описаны в руководстве Процесс проверки гостей.

POST/public/json/customer/inhotelСписок проживающих гостей

Объект#

Поля

uniqueinteger

ID записи о проживании; уникален для каждого гостя и бронирования. Используйте его как ключ пользователя / сессии на стороне хотспота.

rezervasyon_idinteger

ID бронирования. У гостей, живущих в одном номере, это значение общее.

inHotelinteger

1 = гость проживает в отеле. Всегда 1, так как эндпоинт возвращает только проживающих гостей.

firstNamestring

Имя. Обычно в верхнем регистре, так как считывается с удостоверения личности; несколько имён разделяются пробелом.

lastNamestring

Фамилия. Обычно в верхнем регистре.

identityNumberstring | null

Турецкий национальный идентификационный номер или номер паспорта — так, как он указан в документе. Может быть пустым у гостей, зарегистрированных без данных документа.

birthDatestring | null

Дата рождения, DD.MM.YYYY. Может быть пустой.

roomIDinteger

ID номера в HMS.

roomNamestring

Название / номер комнаты — так, как его видит гость на двери и ключ-карте. Именно его запрашивайте на портале как «номер комнаты».

checkininteger

Время заезда гостя в формате Unix timestamp (секунды).

checkoutinteger

Плановая дата выезда в формате Unix timestamp на начало дня (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-ключ из раздела Custom API, созданный в панели управления HMS. Он привязан к одному отелю и определяет, чьи гости попадут в список.

HotelCodeinteger

ID отеля в HMS. Для проверки не используется, так как сервер определяет отель по ключу; рекомендуется передавать для журналирования и совместимости.

Ответ

200 success: 1 и массив otelde. Если в отеле никто не проживает, массив пуст; это не ошибка.

successinteger

1 — успех, 0 — неудача. Это число, а не boolean, как в 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"

const res = await fetch("https://test.hms.gen.tr/public/json/customer/inhotel", {
  method: "POST",
  headers: {
    "ApiKey": process.env.HMS_API_KEY,
    "HotelCode": "1000"
  }
});
const data = await res.json();

$ch = curl_init('https://test.hms.gen.tr/public/json/customer/inhotel');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_HTTPHEADER     => [
        'ApiKey: ' . getenv('HMS_API_KEY'),
        'HotelCode: 1000',
    ],
]);
$data = json_decode(curl_exec($ch), true);

Ответ · 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 г.Нашли ошибку? Напишите нам