Ümumi baxış
Hotspot API oteldə qalan qonaqların siyahısını hotspot (captive portal) sisteminə ötürür. Check-in etmiş və hələ check-out etməmiş hər qonaq üçün HMS otaq nömrəsini, adı, şəxsiyyət nömrəsini, doğum tarixini və check-in/check-out vaxtlarını qaytarır. Hotspot proqramı bu siyahıdan qonağın Wi-Fi girişini otaq nömrəsi və soyad üzrə yoxlamaq, qalma müddəti bitəndə çıxışı bağlamaq və Türkiyənin 5651 saylı qanunu ilə tələb olunan giriş jurnallarını şəxsiyyətlə əlaqələndirmək üçün istifadə edir.
Əsas URL#
Son nöqtə aşağıdakı əsas URL altında, /public/json/… yolunda yerləşir. Yalnız HTTPS qəbul olunur.
https://test.hms.gen.trAxının xülasəsi#
ApiKeyPOST …/customer/inhotelroomName + lastNamediff by uniqueAçar otelin HMS idarəetmə panelində bir dəfə yaradılır və hər sorğuda ApiKey başlığında göndərilir. Siyahı son nöqtəsi oteldə qalan bütün qonaqları bir çağırışda qaytarır; hotspot proqramı qonağın portalda daxil etdiyi otaq nömrəsini və soyadı bu siyahı ilə tutuşdurur, hesabı planlaşdırılan çıxış tarixinədək açır və oteli tərk etmiş qonaqların hesablarını bağlamaq üçün siyahını müntəzəm aralıqlarla yeniləyir. Təfərrüatlar Qonaq yoxlaması axını bələdçisindədir.
Resurslar#
| Resurs | Son nöqtələr |
|---|---|
| Oteldə qalan qonaqlar | POST /public/json/customer/inhotel |
Ümumi qaydalar#
- Hər sorğu
ApiKeybaşlığını daşıyır. Giriş addımı və token yoxdur. - Son nöqtə
POSTilə çağırılır; gövdə, sorğu sətri və ya filtr parametri yoxdur. - Cavablar JSON formatındadır və
successsahəsi1və ya0rəqəmidir. Autentifikasiya uğursuz olduqda HTTP401və{"success": 0}qaytarılır. - Vaxtlar Unix vaxt damğasıdır (saniyə). Doğum tarixi
DD.MM.YYYYformatında sətirdir. - Siyahı bütün oteli əhatə edir; otaq və ya tarix filtri yoxdur. Uyğunlaşdırmanı öz tərəfinizdə aparın və siyahını keşləyin.
- Cavabda şəxsi məlumatlar (şəxsiyyət nömrəsi, doğum tarixi) var. Yalnız lazım olan sahələri saxlayın və sorğunu qonağın cihazından deyil, həmişə öz serverinizdən göndərin.
Versiyalaşdırma#
Bu son nöqtə HMS-in xüsusi API qrupuna aiddir və versiya nömrəsi daşımır. Yeni sahələr xəbərdarlıq edilmədən əlavə oluna bilər; klientinizi tanımadığı sahələrə məhəl qoymayacaq şəkildə yazın. Mövcud sahənin silinməsi və ya mənasının dəyişməsi dəyişikliklər jurnalında əvvəlcədən elan olunur.