Panoramica
L’API Hotspot fornisce l’elenco degli ospiti in hotel al sistema hotspot (captive portal). Per ogni ospite che ha effettuato il check-in ma non ancora il check-out, HMS restituisce numero di camera, nome, numero del documento d’identità, data di nascita e orari di check-in/check-out. Il software hotspot usa l’elenco per verificare l’accesso Wi-Fi dell’ospite tramite numero di camera e cognome, per chiudere l’accesso alla fine del soggiorno e per associare a un’identità i log di accesso che conserva ai sensi della legge turca n. 5651.
URL di base#
L’endpoint si trova sotto l’URL di base riportato qui sotto, nel percorso /public/json/…. È accettato solo HTTPS.
https://test.hms.gen.trSintesi del flusso#
ApiKeyPOST …/customer/inhotelroomName + lastNamediff by uniqueLa chiave viene generata una sola volta nel pannello di amministrazione HMS dell’hotel e inviata nell’header ApiKey a ogni richiesta. L’endpoint dell’elenco restituisce tutti gli ospiti in hotel in un’unica chiamata; il software hotspot confronta con questo elenco il numero di camera e il cognome che l’ospite digita nel portale, apre l’account fino alla data di check-out prevista e aggiorna l’elenco a intervalli regolari per chiudere gli account degli ospiti partiti. I dettagli sono nella guida Flusso di verifica degli ospiti.
Risorse#
| Risorsa | Endpoint |
|---|---|
| Ospiti in hotel | POST /public/json/customer/inhotel |
Regole generali#
- Ogni richiesta include l’header
ApiKey. Non ci sono né login né token. - L’endpoint si chiama con
POST; non ci sono corpo, query string né parametri di filtro. - Le risposte sono in JSON e il campo
successè il numero1o0. Un errore di autenticazione restituisce HTTP401con{"success": 0}. - Gli orari sono timestamp Unix (secondi). La data di nascita è una stringa
DD.MM.YYYY. - L’elenco copre l’intero hotel; non esistono filtri per camera o per data. Esegui la corrispondenza dal tuo lato e tieni l’elenco in cache.
- La risposta contiene dati personali (numero del documento, data di nascita). Conserva solo i campi che ti servono e invia la richiesta dal tuo server, mai dal dispositivo dell’ospite.
Versioni#
Questo endpoint fa parte del gruppo di API personalizzate di HMS e non ha un numero di versione. Nuovi campi possono essere aggiunti senza preavviso: scrivi il tuo client in modo che ignori i campi che non conosce. La rimozione di un campo esistente o la modifica del suo significato vengono annunciate in anticipo nelle note di rilascio.