Genel bakış

Hotspot API, oteldeki misafir listesini hotspot (captive portal) sistemine verir. HMS, check-in yapılmış ve henüz çıkış yapmamış her misafir için oda numarası, ad-soyad, kimlik numarası, doğum tarihi ve giriş-çıkış zamanını döner. Hotspot yazılımı bu listeyle misafirin Wi-Fi girişini oda numarası ve soyadıyla doğrular, konaklama bitince erişimi kapatır ve 5651 sayılı kanun gereği tuttuğu erişim kayıtlarını kimlik bilgisiyle ilişkilendirir.

Temel adres#

Uç nokta aşağıdaki kök adresin altında, /public/json/… yolunda yer alır. Yalnızca HTTPS kabul edilir.

https://test.hms.gen.tr

Akış özeti#

Anahtar otelin HMS yönetim panelinde bir kez üretilir ve her istekte ApiKey başlığında gönderilir. Liste uç noktası oteldeki tüm misafirleri tek seferde döner; hotspot yazılımı misafirin portalda girdiği oda numarası ve soyadı bu listeyle eşleştirir, hesabı planlanan çıkış tarihine kadar açar ve listeyi düzenli aralıklarla yenileyerek çıkış yapanları kapatır. Ayrıntılı anlatım Misafir doğrulama akışı rehberindedir.

Kaynaklar#

Genel kurallar#

• Her istek ApiKey başlığı taşır. Giriş adımı ve token yoktur.
• Uç nokta POST ile çağrılır; gövde, sorgu ya da filtre parametresi yoktur.
• Yanıt JSON’dur ve success alanı 1 ya da 0 sayısıdır. Kimlik doğrulama hatası HTTP 401 ile {"success": 0} döner.
• Zamanlar Unix zaman damgasıdır (saniye). Doğum tarihi GG.AA.YYYY biçiminde metindir.
• Liste otelin tamamını kapsar; oda ya da tarih filtresi yoktur. Eşleştirmeyi kendi tarafınızda yapın ve listeyi önbelleğe alın.
• Yanıtta kişisel veri (kimlik numarası, doğum tarihi) bulunur. Yalnızca gereken alanları saklayın; isteği misafir cihazından değil kendi sunucunuzdan gönderin.

Sürüm#

Bu uç nokta HMS’nin özel API grubundadır ve sürüm numarası taşımaz. Yeni alanlar duyurusuz eklenebilir; istemcinizi tanımadığı alanları yok sayacak şekilde yazın. Mevcut bir alanın kaldırılması ya da anlamının değişmesi sürüm notlarında önceden duyurulur.

Sonraki adımlar#