Аутентификация

Hotspot API использует для аутентификации один HTTP-заголовок — ApiKey. Отдельного входа и токена нет: ключ передаётся в каждом запросе.

Заголовки#

POST /public/json/customer/inhotel HTTP/1.1
Host: test.hms.gen.tr
ApiKey: 017f1daf2d139
HotelCode: 1000
Content-Length: 0

Где взять ключ#

Ключ создаётся на вкладке Custom API страницы API в панели управления HMS отеля. В поле описания отмечают, где используется ключ; можно создать несколько ключей. Ключ, удалённый на той же странице, сразу становится недействительным.

Ошибка аутентификации#

Если заголовок отсутствует или пуст либо ключ не найден в HMS, возвращается HTTP 401 с таким телом:

{
    "success": 0
}

Подробности ошибки не сообщаются. Проверьте по порядку: имя заголовка — ApiKey; значение в точности совпадает с ключом, скопированным из панели; ключ по-прежнему есть в списке в панели. Не повторяйте запрос после 401: пока ключ не исправлен, результат не изменится.

Привязка к отелю#

Ключ привязан к одному отелю, и ответ содержит только гостей этого отеля. Если установка обслуживает несколько отелей, получите ключ в панели каждого отеля и храните ключи по отелям. Другой HotelCode не вернёт данные чужого отеля: отель всегда определяется ключом.

Защита ключа#

• Храните ключ в конфигурации сервера хотспота или в переменной окружения; никогда не размещайте его в HTML captive-портала или в клиентском JavaScript.
• Компонент, который получает список, должен работать на сервере. Устройства гостей не должны обращаться к HMS напрямую: ответ содержит личные данные всех гостей.
• Если есть подозрение, что ключ утёк, удалите его в панели и создайте новый. Старый ключ начинает возвращать 401 сразу после удаления.