Επισκόπηση

Το Hotspot API παρέχει στο σύστημα hotspot (captive portal) τη λίστα των διαμενόντων επισκεπτών. Για κάθε επισκέπτη που έχει κάνει check-in και δεν έχει κάνει ακόμη check-out, το HMS επιστρέφει τον αριθμό δωματίου, το ονοματεπώνυμο, τον αριθμό ταυτότητας, την ημερομηνία γέννησης και τις ώρες check-in/check-out. Το λογισμικό hotspot χρησιμοποιεί τη λίστα για να επαληθεύει τη σύνδεση Wi-Fi ενός επισκέπτη με τον αριθμό δωματίου και το επώνυμο, για να κλείνει την πρόσβαση όταν λήγει η διαμονή και για να συνδέει με μια ταυτότητα τα αρχεία πρόσβασης που τηρεί σύμφωνα με τον τουρκικό νόμο αριθ. 5651.

Βασικό URL#

Το τελικό σημείο βρίσκεται κάτω από το παρακάτω βασικό URL, στη διαδρομή /public/json/…. Γίνεται δεκτό μόνο HTTPS.

https://test.hms.gen.tr

Σύνοψη ροής#

Το κλειδί δημιουργείται μία φορά στον πίνακα διαχείρισης HMS του ξενοδοχείου και αποστέλλεται ως κεφαλίδα ApiKey σε κάθε αίτημα. Το τελικό σημείο λίστας επιστρέφει όλους τους διαμένοντες επισκέπτες σε μία κλήση· το λογισμικό hotspot αντιστοιχίζει τον αριθμό δωματίου και το επώνυμο που πληκτρολογεί ο επισκέπτης στο portal με αυτή τη λίστα, ανοίγει τον λογαριασμό έως την προγραμματισμένη ημερομηνία αναχώρησης και ανανεώνει τη λίστα ανά τακτά διαστήματα για να κλείνει τους λογαριασμούς όσων έχουν αναχωρήσει. Οι λεπτομέρειες βρίσκονται στον οδηγό Ροή επαλήθευσης επισκεπτών.

Πόροι#

Γενικοί κανόνες#

• Κάθε αίτημα περιέχει την κεφαλίδα ApiKey. Δεν υπάρχει βήμα σύνδεσης ούτε token.
• Το τελικό σημείο καλείται με POST· δεν υπάρχει σώμα, query string ή παράμετρος φιλτραρίσματος.
• Οι αποκρίσεις είναι JSON και το πεδίο success είναι ο αριθμός 1 ή 0. Μια αποτυχία ελέγχου ταυτότητας επιστρέφει HTTP 401 με {"success": 0}.
• Οι ώρες είναι χρονοσφραγίδες Unix (δευτερόλεπτα). Η ημερομηνία γέννησης είναι συμβολοσειρά DD.MM.YYYY.
• Η λίστα καλύπτει ολόκληρο το ξενοδοχείο· δεν υπάρχει φίλτρο δωματίου ή ημερομηνίας. Κάντε την αντιστοίχιση από τη δική σας πλευρά και κρατήστε τη λίστα στην cache.
• Η απόκριση περιέχει προσωπικά δεδομένα (αριθμό ταυτότητας, ημερομηνία γέννησης). Αποθηκεύστε μόνο τα πεδία που χρειάζεστε και στέλνετε το αίτημα από τον δικό σας διακομιστή, ποτέ από τη συσκευή του επισκέπτη.

Εκδόσεις#

Αυτό το τελικό σημείο ανήκει στην ομάδα προσαρμοσμένων API του HMS και δεν φέρει αριθμό έκδοσης. Νέα πεδία μπορεί να προστεθούν χωρίς προειδοποίηση· γράψτε τον client σας ώστε να αγνοεί πεδία που δεν γνωρίζει. Η αφαίρεση ενός υπάρχοντος πεδίου ή η αλλαγή της σημασίας του ανακοινώνεται εκ των προτέρων στις σημειώσεις έκδοσης.

Επόμενα βήματα#