Обзор

Hotspot API передаёт в систему хотспота (captive-портал) список проживающих гостей. Для каждого гостя, который заселился и ещё не выехал, HMS возвращает номер комнаты, имя, номер документа, дату рождения и время заезда и выезда. ПО хотспота использует этот список, чтобы проверять вход гостя в Wi-Fi по номеру комнаты и фамилии, закрывать доступ по окончании проживания и привязывать к личности журналы доступа, которые оно ведёт по закону Турции № 5651.

Базовый URL#

Эндпоинт находится по пути /public/json/… относительно базового URL ниже. Принимаются только запросы по HTTPS.

Базовый URL
https://test.hms.gen.tr

Схема работы#

1КлючApiKey
2СписокPOST …/customer/inhotel
3СопоставлениеroomName + lastName
4Обновлениеdiff by unique

Ключ один раз создаётся в панели управления HMS отеля и передаётся в заголовке ApiKey в каждом запросе. Эндпоинт списка за один вызов возвращает всех проживающих гостей; ПО хотспота сопоставляет с этим списком номер комнаты и фамилию, которые гость вводит на портале, открывает учётную запись до плановой даты выезда и регулярно обновляет список, чтобы закрывать учётные записи выехавших гостей. Подробности — в руководстве Процесс проверки гостей.

Ресурсы#

РесурсЭндпоинты
Проживающие гостиPOST /public/json/customer/inhotel

Общие правила#

  • Каждый запрос содержит заголовок ApiKey. Отдельного входа и токена нет.
  • Эндпоинт вызывается методом POST; тела запроса, строки запроса и параметров фильтрации нет.
  • Ответы приходят в JSON, а поле success содержит число 1 или 0. При ошибке аутентификации возвращается HTTP 401 с телом {"success": 0}.
  • Время передаётся в виде Unix timestamp (секунды). Дата рождения — строка в формате DD.MM.YYYY.
  • Список охватывает весь отель; фильтра по номеру или дате нет. Сопоставляйте данные на своей стороне и кешируйте список.
  • Ответ содержит персональные данные (номер документа, дату рождения). Храните только нужные поля и отправляйте запрос со своего сервера, а не с устройства гостя.

Версионирование#

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

Следующие шаги#

Быстрый стартСоздайте ключ и получите первый список. АутентификацияЗаголовок ApiKey и управление ключами. Процесс проверки гостейСопоставление, длительность сессии, синхронизация. Справочник APIПоля, примеры запросов и ответов.
Последнее обновление:: 21 сентября 2026 г.Нашли ошибку? Напишите нам