Бързо начало

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

1. Генерирайте ключ#

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

export HMS_API_KEY="017f1daf2d139"

Запишете си и HMS ID на хотела; примерите го изпращат като 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 е уникален за всеки гост; обвържете hotspot потребителя с него. rezervasyon_id е общ за гостите в една стая.
• Номерът на стаята, който се въвежда в портала, се сравнява с roomName, а фамилията — с lastName. Стойностите обикновено са с главни букви.
• checkin е моментът на настаняване; checkout е планираната дата на напускане (00:00 UTC) без час. Добавете часа за напускане на хотела, за да получите края на сесията.
• Ако в хотела няма гости, otelde е празен масив, а success пак е 1.

Какво следва#

• Процес на проверка на гостите — правила за съпоставяне, продължителност на сесията, периодична синхронизация
• Удостоверяване — управление на ключове и отговорът 401
• API справочник — описание на всички полета