Overzicht
De Hotspot API levert de lijst met aanwezige gasten aan het hotspotsysteem (captive portal). Voor elke gast die is ingecheckt en nog niet is uitgecheckt, geeft HMS het kamernummer, de naam, het identiteitsnummer, de geboortedatum en de in- en uitchecktijden terug. De hotspotsoftware gebruikt de lijst om de wifi-login van een gast te verifiëren op kamernummer en achternaam, om de toegang te sluiten wanneer het verblijf afloopt, en om de toegangslogs die het volgens de Turkse Wet nr. 5651 bijhoudt aan een identiteit te koppelen.
Basis-URL#
Het endpoint staat onder de onderstaande basis-URL, op het pad /public/json/…. Alleen HTTPS wordt geaccepteerd.
https://test.hms.gen.trOverzicht van de flow#
ApiKeyPOST …/customer/inhotelroomName + lastNamediff by uniqueDe sleutel wordt één keer aangemaakt in het HMS-beheerpaneel van het hotel en bij elk verzoek meegestuurd als header ApiKey. Het lijstendpoint geeft alle aanwezige gasten in één aanroep terug; de hotspotsoftware vergelijkt het kamernummer en de achternaam die de gast op het portal invoert met deze lijst, opent het account tot de geplande uitcheckdatum en vernieuwt de lijst met vaste tussenpozen om de accounts van vertrokken gasten te sluiten. De details staan in de handleiding Gastverificatieflow.
Resources#
| Resource | Endpoints |
|---|---|
| Aanwezige gasten | POST /public/json/customer/inhotel |
Algemene regels#
- Elk verzoek bevat de header
ApiKey. Er is geen loginstap en geen token. - Het endpoint wordt aangeroepen met
POST; er is geen body, querystring of filterparameter. - Antwoorden zijn JSON en het veld
successis het getal1of0. Mislukt de authenticatie, dan krijg je HTTP401met{"success": 0}. - Tijden zijn Unix-timestamps (seconden). De geboortedatum is een string in de vorm
DD.MM.YYYY. - De lijst omvat het hele hotel; er is geen filter op kamer of datum. Match aan jouw kant en cache de lijst.
- Het antwoord bevat persoonsgegevens (identiteitsnummer, geboortedatum). Bewaar alleen de velden die je nodig hebt en stuur het verzoek vanaf je eigen server, nooit vanaf het apparaat van de gast.
Versiebeheer#
Dit endpoint hoort bij de groep eigen API’s (Custom API) van HMS en heeft geen versienummer. Nieuwe velden kunnen zonder aankondiging worden toegevoegd; schrijf je client zo dat velden die hij niet kent worden genegeerd. Het verwijderen van een bestaand veld of het wijzigen van de betekenis ervan wordt vooraf aangekondigd in de releasenotes.