Огляд
Hotspot API передає список гостей, які проживають у готелі, до системи hotspot (captive portal). Для кожного гостя, який заселився й ще не виселився, HMS повертає номер кімнати, ім’я, номер документа, дату народження та час заїзду й виїзду. Програма hotspot використовує цей список, щоб перевіряти вхід гостя у Wi-Fi за номером кімнати й прізвищем, закривати доступ після завершення проживання та пов’язувати з особою журнали доступу, які вона веде згідно з турецьким законом № 5651.
Базова URL-адреса#
Ендпоінт розміщено за базовою URL-адресою нижче, у шляху /public/json/…. Приймаються лише запити через HTTPS.
https://test.hms.gen.trКороткий опис процесу#
ApiKeyPOST …/customer/inhotelroomName + lastNamediff by uniqueКлюч створюється один раз у панелі адміністратора HMS готелю й надсилається в заголовку ApiKey у кожному запиті. Ендпоінт списку одним викликом повертає всіх гостей, які проживають у готелі; програма hotspot зіставляє з цим списком номер кімнати й прізвище, які гість вводить на порталі, відкриває обліковий запис до запланованої дати виїзду й регулярно оновлює список, щоб закривати облікові записи гостей, які виїхали. Докладніше — у посібнику Процес перевірки гостей.
Ресурси#
| Ресурс | Ендпоінти |
|---|---|
| Гості в готелі | POST /public/json/customer/inhotel |
Загальні правила#
- Кожен запит містить заголовок
ApiKey. Кроку входу й токена немає. - Ендпоінт викликається методом
POST; тіла, рядка запиту й параметрів фільтрації немає. - Відповіді надходять у форматі JSON, а поле
success— це число1або0. У разі помилки автентифікації повертається HTTP401з{"success": 0}. - Час передається як мітка часу Unix (у секундах). Дата народження — рядок у форматі
DD.MM.YYYY. - Список охоплює весь готель; фільтрів за номером чи датою немає. Зіставляйте дані на своєму боці й кешуйте список.
- Відповідь містить персональні дані (номер документа, дату народження). Зберігайте лише потрібні вам поля й надсилайте запит зі свого сервера, а не з пристрою гостя.
Версіонування#
Цей ендпоінт належить до групи власних API HMS і не має номера версії. Нові поля можуть з’являтися без попередження, тому пишіть клієнт так, щоб він ігнорував невідомі поля. Про вилучення наявного поля або зміну його значення ми заздалегідь повідомляємо в журналі змін.