Autentificare

API-ul Hotspot se autentifică printr-un singur antet HTTP: ApiKey. Nu există un pas separat de login și nici token; cheia se trimite la fiecare cerere.

Anteturi#

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

De unde provine cheia#

Cheia se generează în fila Custom API a paginii API din panoul de administrare HMS al hotelului. Câmpul de descriere servește la notarea locului în care este folosită cheia; se pot genera mai multe chei. O cheie ștearsă pe aceeași pagină devine imediat nevalidă.

Autentificare eșuată#

Dacă antetul lipsește sau este gol ori cheia nu este găsită în HMS, răspunsul este HTTP 401, cu acest corp:

{
    "success": 0
}

Nu se oferă detalii despre eroare. Verificați în această ordine: numele antetului este ApiKey, valoarea este exact cheia copiată din panou, iar cheia apare încă în lista din panou. Nu reîncercați un 401; rezultatul nu se schimbă până când cheia nu este corectată.

Contextul hotelului#

O cheie este legată de un singur hotel; răspunsul conține doar oaspeții acelui hotel. Pentru o instalare care deservește mai multe hoteluri, obțineți câte o cheie din panoul propriu al fiecărui hotel și stocați-le separat, pe hotel. Trimiterea unui alt HotelCode nu returnează datele altui hotel; hotelul este determinat întotdeauna de cheie.

Protejarea cheii#

• Păstrați cheia în configurația serverului hotspot sau într-o variabilă de mediu; nu o puneți niciodată în HTML-ul portalului captiv sau în JavaScript pe partea de client.
• Componenta care obține lista trebuie să ruleze pe server. Dispozitivele oaspeților nu trebuie să apeleze direct HMS; răspunsul conține datele de identitate ale tuturor oaspeților.
• Dacă bănuiți că cheia a fost compromisă, ștergeți-o din panou și generați una nouă. Vechea cheie returnează 401 din momentul în care este ștearsă.