Clients en séjour

L’unique ressource de l’intégration hotspot. Renvoie la chambre, l’identité et les informations d’arrivée et de départ de chaque client actuellement en séjour (check-in effectué, check-out pas encore effectué). Le logiciel hotspot récupère cette liste à intervalles réguliers et ouvre ou ferme les comptes Wi-Fi en conséquence ; les étapes sont décrites dans le guide Flux de vérification des clients.

POST/public/json/customer/inhotelListe des clients en séjour

Objet#

Champs

uniqueinteger
Identifiant de l’enregistrement de séjour, unique par client et par réservation. Utilisez-le comme clé d’utilisateur / de session côté hotspot.
rezervasyon_idinteger
Identifiant de la réservation. Les clients qui partagent une chambre ont la même valeur.
inHotelinteger
1 = le client est en séjour. Toujours 1, puisque l’endpoint ne renvoie que les clients en séjour.
firstNamestring
Prénom. Généralement en majuscules, tel que lu sur la pièce d’identité ; les prénoms multiples sont séparés par des espaces.
lastNamestring
Nom de famille. Généralement en majuscules.
identityNumberstring | null
Numéro d’identité national turc ou numéro de passeport, tel qu’imprimé sur le document. Peut être vide pour les clients enregistrés sans pièce d’identité.
birthDatestring | null
Date de naissance, DD.MM.YYYY. Peut être vide.
roomIDinteger
Identifiant HMS de la chambre.
roomNamestring
Nom / numéro de la chambre, tel que le client le voit sur la porte et sur sa carte-clé. C’est ce que vous demandez comme « numéro de chambre » sur le portail.
checkininteger
Heure d’arrivée du client, en horodatage Unix (secondes).
checkoutinteger
Date de départ prévue, en horodatage Unix correspondant au début de la journée (00:00 UTC) ; elle ne contient aucune heure. Ajoutez l’heure de départ de l’hôtel (généralement 12:00) pour obtenir la fin de session.
checkout2integer | null
Heure de départ effective. null pour les clients en séjour ; un client qui fait son check-out disparaît de toute façon de la liste.
mikrotikSifrelemeinteger
Paramètre de chiffrement Mikrotik du bâtiment de la chambre dans HMS : 0 nom de la chambre (le mot de passe Wi-Fi est le numéro de chambre), 1 sans mot de passe. Appliquez la même politique sur votre propre portail.
01
Exemple d’objet
{
    "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 des clients en séjour#

POST/public/json/customer/inhotel

Authentification: En-tête ApiKey

Renvoie la liste complète des clients en séjour. Il n’y a ni paramètre de filtre ni corps de requête. Un client apparaît dans la liste lorsque la réservation est active, que le check-in a été effectué mais pas encore le check-out, et que le client est marqué « en séjour ». Chaque client d’une même réservation constitue un enregistrement distinct.

La réponse n’est pas paginée ; les grands hôtels peuvent renvoyer plusieurs centaines d’enregistrements. Mettez la liste en cache et actualisez-la à l’intervalle recommandé.

En-têtes

ApiKeystringobligatoire
Clé API personnalisée générée dans le panneau d’administration HMS. Elle est liée à un seul hôtel, qui détermine les clients listés.
HotelCodeinteger
Identifiant HMS de l’hôtel. Non utilisé pour la validation, puisque le serveur déduit l’hôtel de la clé ; recommandé pour la journalisation et la compatibilité.

Réponse

200 success: 1 et le tableau otelde. Si aucun client n’est en séjour, le tableau est vide ; ce n’est pas une erreur.

successinteger
1 succès, 0 échec. Un nombre, et non un booléen comme dans Online Booking.
otelde[]object[]
Enregistrements des clients. Voir la section Objet ci-dessus pour les champs.

Réponses d’erreur

  • 401 En-tête ApiKey absent, vide ou non défini dans HMS (la clé a peut-être été supprimée). Corps : {"success": 0}.
  • 405 La requête a utilisé une méthode autre que POST (par exemple GET depuis la barre d’adresse d’un navigateur).
Requête
curl -X POST "https://test.hms.gen.tr/public/json/customer/inhotel" \
  -H "ApiKey: $HMS_API_KEY" \
  -H "HotelCode: 1000"
Réponse · 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
        }
    ]
}
Réponse · 200 (aucun client en séjour)
{
    "success": 1,
    "otelde": []
}
Réponse · 401 (clé invalide)
{
    "success": 0
}
Dernière mise à jour: 21 septembre 2026Vous avez repéré une erreur ? Signalez-la-nous