Удостоверяване

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 не връща данни на друг хотел; хотелът винаги се определя от ключа.

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

• Съхранявайте ключа в конфигурацията на hotspot сървъра или в променлива на средата; никога не го поставяйте в HTML кода на captive портала или в JavaScript от страна на клиента.
• Компонентът, който изтегля списъка, трябва да работи на сървъра. Устройствата на гостите не бива да извикват HMS директно; отговорът съдържа данни за самоличността на всички гости.
• Ако подозирате, че ключът е компрометиран, изтрийте го в панела и генерирайте нов. Старият ключ връща 401 от момента на изтриването си.