Vue d’ensemble

L’API Hotspot transmet la liste des clients en séjour au système hotspot (portail captif). Pour chaque client qui a effectué son check-in et pas encore son check-out, HMS renvoie le numéro de chambre, le nom, le numéro d’identité, la date de naissance ainsi que les heures d’arrivée et de départ. Le logiciel hotspot utilise cette liste pour vérifier la connexion Wi-Fi d’un client à partir de son numéro de chambre et de son nom de famille, pour couper l’accès à la fin du séjour et pour rattacher à une identité les journaux d’accès qu’il conserve au titre de la loi turque n° 5651.

URL de base#

L’endpoint se trouve sous l’URL de base ci-dessous, dans le chemin /public/json/…. Seul HTTPS est accepté.

https://test.hms.gen.tr

Aperçu du flux#

La clé est générée une seule fois dans le panneau d’administration HMS de l’hôtel et envoyée dans l’en-tête ApiKey à chaque requête. L’endpoint de liste renvoie tous les clients en séjour en un seul appel ; le logiciel hotspot compare le numéro de chambre et le nom de famille saisis par le client sur le portail avec cette liste, ouvre le compte jusqu’à la date de départ prévue et actualise la liste à intervalles réguliers pour fermer les comptes des clients partis. Tous les détails figurent dans le guide Flux de vérification des clients.

Ressources#

Règles générales#

• Chaque requête porte l’en-tête ApiKey. Il n’y a ni étape de connexion ni jeton.
• L’endpoint s’appelle en POST ; il n’y a ni corps, ni chaîne de requête, ni paramètre de filtre.
• Les réponses sont en JSON et le champ success vaut le nombre 1 ou 0. Un échec d’authentification renvoie HTTP 401 avec {"success": 0}.
• Les heures sont des horodatages Unix (en secondes). La date de naissance est une chaîne au format DD.MM.YYYY.
• La liste couvre tout l’hôtel ; il n’existe aucun filtre par chambre ou par date. Effectuez la correspondance de votre côté et mettez la liste en cache.
• La réponse contient des données personnelles (numéro d’identité, date de naissance). Ne stockez que les champs dont vous avez besoin et envoyez la requête depuis votre propre serveur, jamais depuis l’appareil du client.

Gestion des versions#

Cet endpoint appartient au groupe d’API personnalisées de HMS et ne porte pas de numéro de version. De nouveaux champs peuvent être ajoutés sans préavis ; écrivez votre client de sorte qu’il ignore les champs qu’il ne connaît pas. La suppression d’un champ existant ou le changement de sa signification sont annoncés à l’avance dans les notes de version.

Étapes suivantes#