Общ преглед
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; няма тяло, query низ или параметри за филтриране. - Отговорите са в JSON, а полето
successе числото1или0. При неуспешно удостоверяване се връща HTTP401с{"success": 0}. - Часовете са Unix времеви печати (секунди). Датата на раждане е низ във формат
DD.MM.YYYY. - Списъкът обхваща целия хотел; няма филтър по стая или дата. Съпоставяйте от ваша страна и кеширайте списъка.
- Отговорът съдържа лични данни (номер на документ за самоличност, дата на раждане). Съхранявайте само нужните ви полета и изпращайте заявката от собствения си сървър, никога от устройството на госта.
Версии#
Тази крайна точка е част от групата специални API на HMS и няма номер на версия. Нови полета могат да се добавят без предупреждение; пишете клиента си така, че да пренебрегва непознати полета. Премахването на съществуващо поле или промяната на значението му се обявява предварително в дневника на промените.