Überblick

Die Hotspot API stellt dem Hotspot-System (Captive Portal) die Liste der Gäste im Haus bereit. Für jeden Gast, der eingecheckt und noch nicht ausgecheckt hat, liefert HMS Zimmernummer, Name, Ausweisnummer, Geburtsdatum sowie Check-in- und Check-out-Zeiten. Die Hotspot-Software verwendet die Liste, um die WLAN-Anmeldung eines Gastes anhand von Zimmernummer und Nachname zu prüfen, den Zugang am Ende des Aufenthalts zu sperren und die nach dem türkischen Gesetz Nr. 5651 geführten Zugriffsprotokolle einer Identität zuzuordnen.

Basis-URL#

Der Endpunkt liegt unter der folgenden Basis-URL im Pfad /public/json/…. Es wird ausschließlich HTTPS akzeptiert.

https://test.hms.gen.tr

Ablauf im Überblick#

Der Schlüssel wird einmalig im HMS-Admin-Panel des Hotels erzeugt und bei jeder Anfrage als ApiKey-Header gesendet. Der Listen-Endpunkt gibt alle Gäste im Haus mit einem Aufruf zurück; die Hotspot-Software gleicht die Zimmernummer und den Nachnamen, die der Gast im Portal eingibt, mit dieser Liste ab, schaltet das Konto bis zum geplanten Abreisedatum frei und aktualisiert die Liste in regelmäßigen Abständen, um die Konten abgereister Gäste zu schließen. Die Einzelheiten beschreibt der Leitfaden Ablauf der Gästeverifizierung.

Ressourcen#

Allgemeine Regeln#

• Jede Anfrage enthält den ApiKey-Header. Es gibt weder einen Anmeldeschritt noch ein Token.
• Der Endpunkt wird mit POST aufgerufen; es gibt keinen Body, keinen Query-String und keine Filterparameter.
• Antworten sind JSON, und das Feld success ist die Zahl 1 oder 0. Bei fehlgeschlagener Authentifizierung wird HTTP 401 mit {"success": 0} zurückgegeben.
• Zeitangaben sind Unix-Zeitstempel (Sekunden). Das Geburtsdatum ist ein String im Format DD.MM.YYYY.
• Die Liste umfasst das gesamte Hotel; es gibt keinen Zimmer- oder Datumsfilter. Gleichen Sie auf Ihrer Seite ab und speichern Sie die Liste zwischen.
• Die Antwort enthält personenbezogene Daten (Ausweisnummer, Geburtsdatum). Speichern Sie nur die Felder, die Sie benötigen, und senden Sie die Anfrage von Ihrem eigenen Server, niemals vom Gerät des Gastes.

Versionierung#

Dieser Endpunkt gehört zur Custom-API-Gruppe von HMS und trägt keine Versionsnummer. Neue Felder können ohne Ankündigung hinzukommen; schreiben Sie Ihren Client so, dass er unbekannte Felder ignoriert. Das Entfernen eines bestehenden Felds oder eine Änderung seiner Bedeutung wird vorab in den Versionshinweisen angekündigt.

Nächste Schritte#