Быстрый старт

На этой странице вы создадите API-ключ в панели HMS отеля и получите список проживающих гостей. Понадобится доступ к панели под пользователем, которому разрешено управлять API-ключами; если такого доступа нет, ключ может создать и передать вам администрация отеля.

1. Создайте ключ#

• В панели управления HMS откройте страницу API и перейдите на вкладку Custom API.
• В поле описания укажите, где будет использоваться ключ (например, Hotspot – главный корпус), и сохраните. HMS создаст ключ длиной 13 символов.
• Скопируйте ключ из списка. Он привязан к отелю и не имеет срока действия; ключ становится недействительным в момент удаления из списка.

export HMS_API_KEY="017f1daf2d139"

Запишите также ID отеля в HMS; в примерах он передаётся как HotelCode: 1000. Этот заголовок не используется для проверки, но по нему в журналах видно, для какого отеля выполнялся запрос.

2. Получите список#

Эндпоинт вызывается методом POST без тела:

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"
  }
});
if (res.status === 401) throw new Error("Invalid ApiKey");
const data = await res.json();
for (const g of data.otelde) {
  console.log(g.roomName, g.firstName, g.lastName, new Date(g.checkout * 1000));
}

$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',
    ],
]);
$body = curl_exec($ch);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) === 401) {
    throw new RuntimeException('Invalid ApiKey');
}
$data = json_decode($body, true);
foreach ($data['otelde'] as $g) {
    echo $g['roomName'], ' · ', $g['firstName'], ' ', $g['lastName'], ' · ', date('d.m.Y', $g['checkout']), "\n";
}

3. Разберите ответ#

Каждый проживающий гость — отдельная запись в массиве otelde. Сокращённый пример для двух гостей, живущих в одном номере:

{
    "success": 1,
    "otelde": [
        {
            "unique": 58211,
            "firstName": "AYŞE",
            "lastName": "DEMİR",
            "identityNumber": "11111111110",
            "birthDate": "14.03.1985",
            "roomID": 4,
            "roomName": "104",
            "checkin": 1788863400,
            "checkout": 1788998400,
            "rezervasyon_id": 282799
        },
        {
            "unique": 58212,
            "firstName": "MEHMET",
            "lastName": "DEMİR",
            "identityNumber": "22222222220",
            "birthDate": "02.11.1982",
            "roomID": 4,
            "roomName": "104",
            "checkin": 1788863400,
            "checkout": 1788998400,
            "rezervasyon_id": 282799
        }
    ]
}

• unique уникален для каждого гостя — привяжите к нему пользователя хотспота. rezervasyon_id общий у гостей одного номера.
• Номер комнаты, который запрашивается на портале, сравнивается с roomName, а фамилия — с lastName. Значения обычно в верхнем регистре.
• checkin — момент заезда; checkout — плановая дата выезда (00:00 UTC) без времени суток. Чтобы получить окончание сессии, прибавьте расчётный час отеля.
• Если в отеле никто не проживает, otelde — пустой массив, а success по-прежнему равен 1.

Что дальше#

• Процесс проверки гостей — правила сопоставления, длительность сессии, периодическая синхронизация
• Аутентификация — управление ключами и ответ 401
• Справочник API — описание всех полей