Gäste im Haus

Die einzige Ressource der Hotspot-Integration. Liefert Zimmer-, Identitäts- sowie Check-in- und Check-out-Daten aller Gäste, die sich derzeit im Haus befinden (eingecheckt, noch nicht ausgecheckt). Die Hotspot-Software ruft diese Liste in regelmäßigen Abständen ab und öffnet bzw. schließt WLAN-Konten entsprechend; die Schritte beschreibt der Leitfaden Ablauf der Gästeverifizierung.

Objekt#

Felder

uniqueinteger
ID des Aufenthaltsdatensatzes, eindeutig je Gast und Reservierung. Verwenden Sie sie auf Hotspot-Seite als Benutzer- bzw. Sitzungsschlüssel.
rezervasyon_idinteger
Reservierungs-ID. Gäste im selben Zimmer haben denselben Wert.
inHotelinteger
1 = der Gast ist im Haus. Immer 1, da der Endpunkt nur Gäste im Haus zurückgibt.
firstNamestring
Vorname. Meist in Großbuchstaben, da aus dem Ausweisdokument übernommen; mehrere Vornamen sind durch Leerzeichen getrennt.
lastNamestring
Nachname. Meist in Großbuchstaben.
identityNumberstring | null
Türkische Identitätsnummer oder Reisepassnummer, wie im Dokument angegeben. Kann bei Gästen leer sein, die ohne Ausweisdaten erfasst wurden.
birthDatestring | null
Geburtsdatum, DD.MM.YYYY. Kann leer sein.
roomIDinteger
Die HMS-ID des Zimmers.
roomNamestring
Zimmername bzw. -nummer, wie der Gast sie an der Tür und auf der Schlüsselkarte sieht. Fragen Sie diesen Wert im Portal als „Zimmernummer“ ab.
checkininteger
Check-in-Zeitpunkt des Gastes als Unix-Zeitstempel (Sekunden).
checkoutinteger
Geplantes Abreisedatum als Unix-Zeitstempel zum Tagesbeginn (00:00 UTC); enthält keine Uhrzeit. Addieren Sie die Check-out-Zeit des Hotels (meist 12:00 Uhr), um das Sitzungsende zu erhalten.
checkout2integer | null
Tatsächlicher Check-out-Zeitpunkt. null bei Gästen im Haus; ein Gast, der auscheckt, fällt ohnehin aus der Liste.
mikrotikSifrelemeinteger
Die Mikrotik-Verschlüsselungseinstellung des Gebäudes, in dem das Zimmer liegt, in HMS: 0 Zimmername (das WLAN-Passwort ist die Zimmernummer), 1 kein Passwort. Wenden Sie in Ihrem eigenen Portal dieselbe Regel an.
01
Beispielobjekt
{
    "mikrotikSifreleme": 0,
    "unique": 58211,
    "inHotel": 1,
    "identityNumber": "11111111110",
    "firstName": "AYŞE",
    "lastName": "DEMİR",
    "birthDate": "14.03.1985",
    "roomID": 4,
    "roomName": "104",
    "checkin": 1788863400,
    "checkout": 1788998400,
    "checkout2": null,
    "rezervasyon_id": 282799
}

Liste der Gäste im Haus#

POST/public/json/customer/inhotel

Authentifizierung: ApiKey-Header

Gibt die vollständige Liste der Gäste im Haus zurück. Es gibt keine Filterparameter und keinen Request-Body. Ein Gast erscheint in der Liste, wenn die Reservierung aktiv, eingecheckt und noch nicht ausgecheckt ist und der Gast als „im Haus“ markiert ist. Jeder Gast derselben Reservierung ist ein eigener Datensatz.

Die Antwort ist nicht paginiert; große Hotels können mehrere Hundert Datensätze zurückgeben. Speichern Sie die Liste zwischen und aktualisieren Sie sie im empfohlenen Intervall.

Header

ApiKeystringerforderlich
Custom-API-Schlüssel, im HMS-Admin-Panel erzeugt. Er ist an ein Hotel gebunden und legt damit fest, welche Gäste gelistet werden.
HotelCodeinteger
Die HMS-ID des Hotels. Wird nicht zur Validierung verwendet, da der Server das Hotel anhand des Schlüssels ermittelt; zur Protokollierung und Kompatibilität empfohlen.

Antwort

200 success: 1 und das Array otelde. Ist niemand im Haus, ist das Array leer; das ist kein Fehler.

successinteger
1 Erfolg, 0 Fehlschlag. Eine Zahl, kein Boolean wie bei Online Booking.
otelde[]object[]
Gästedatensätze. Die Felder finden Sie oben im Abschnitt Objekt.

Fehlerantworten

  • 401 ApiKey-Header fehlt, ist leer oder der Schlüssel ist in HMS nicht definiert (möglicherweise gelöscht). Body: {"success": 0}.
  • 405 Die Anfrage verwendete eine andere Methode als POST (zum Beispiel GET über die Adresszeile des Browsers).
Anfrage
curl -X POST "https://test.hms.gen.tr/public/json/customer/inhotel" \
  -H "ApiKey: $HMS_API_KEY" \
  -H "HotelCode: 1000"
Antwort · 200
{
    "success": 1,
    "otelde": [
        {
            "mikrotikSifreleme": 0,
            "unique": 58211,
            "inHotel": 1,
            "identityNumber": "11111111110",
            "firstName": "AYŞE",
            "lastName": "DEMİR",
            "birthDate": "14.03.1985",
            "roomID": 4,
            "roomName": "104",
            "checkin": 1788863400,
            "checkout": 1788998400,
            "checkout2": null,
            "rezervasyon_id": 282799
        },
        {
            "mikrotikSifreleme": 0,
            "unique": 58212,
            "inHotel": 1,
            "identityNumber": "22222222220",
            "firstName": "MEHMET",
            "lastName": "DEMİR",
            "birthDate": "02.11.1982",
            "roomID": 4,
            "roomName": "104",
            "checkin": 1788863400,
            "checkout": 1788998400,
            "checkout2": null,
            "rezervasyon_id": 282799
        },
        {
            "mikrotikSifreleme": 0,
            "unique": 58197,
            "inHotel": 1,
            "identityNumber": "U01234567",
            "firstName": "JULIA",
            "lastName": "WAGNER",
            "birthDate": "27.06.1990",
            "roomID": 12,
            "roomName": "205",
            "checkin": 1788782700,
            "checkout": 1789084800,
            "checkout2": null,
            "rezervasyon_id": 282803
        }
    ]
}
Antwort · 200 (keine Gäste im Haus)
{
    "success": 1,
    "otelde": []
}
Antwort · 401 (ungültiger Schlüssel)
{
    "success": 0
}
Zuletzt aktualisiert: 21. September 2026Fehler gefunden? Schreiben Sie uns