მიმოხილვა
Hotspot API სასტუმროში მყოფი სტუმრების სიას აწვდის hotspot (captive portal) სისტემას. ყოველი სტუმრისთვის, რომელიც ჩასახლებულია და ჯერ არ გაწერილა, HMS აბრუნებს ოთახის ნომერს, სახელს, პირადობის ნომერს, დაბადების თარიღსა და ჩასახლების/გაწერის დროს. Hotspot პროგრამა ამ სიას იყენებს სტუმრის Wi-Fi-ში შესვლის ოთახის ნომრითა და გვარით დასადასტურებლად, ყოფნის დასრულებისას წვდომის დასახურად და თურქეთის №5651 კანონით გათვალისწინებული წვდომის ჟურნალის კონკრეტულ პიროვნებასთან დასაკავშირებლად.
საბაზო URL#
ენდპოინტი ქვემოთ მოცემულ საბაზო URL-ზე, /public/json/… ბილიკზეა განთავსებული. მიიღება მხოლოდ HTTPS.
https://test.hms.gen.trპროცესის მიმოხილვა#
ApiKeyPOST …/customer/inhotelroomName + lastNamediff by uniqueგასაღები ერთხელ იქმნება სასტუმროს HMS-ის მართვის პანელში და ყოველ მოთხოვნაში ApiKey სათაურით იგზავნება. სიის ენდპოინტი ერთი გამოძახებით აბრუნებს სასტუმროში მყოფ ყველა სტუმარს; hotspot პროგრამა პორტალზე სტუმრის მიერ შეყვანილ ოთახის ნომერსა და გვარს ამ სიას ადარებს, ანგარიშს გაწერის დაგეგმილ თარიღამდე ხსნის და სიას რეგულარული ინტერვალებით ანახლებს, რათა წასული სტუმრების ანგარიშები დახუროს. დეტალები აღწერილია სახელმძღვანელოში სტუმრის ვერიფიკაციის პროცესი.
რესურსები#
| რესურსი | ენდპოინტები |
|---|---|
| სასტუმროში მყოფი სტუმრები | POST /public/json/customer/inhotel |
ზოგადი წესები#
- ყოველი მოთხოვნა შეიცავს
ApiKeyსათაურს. შესვლის ეტაპი და ტოკენი არ არსებობს. - ენდპოინტი
POSTმეთოდით გამოიძახება; ტანი, მოთხოვნის სტრიქონი და ფილტრის პარამეტრები არ არის. - პასუხები JSON ფორმატშია, ხოლო
successველი რიცხვია:1ან0. ავთენტიფიკაციის შეცდომისას ბრუნდება HTTP401და{"success": 0}. - დრო მოცემულია Unix დროის ნიშნულებით (წამები). დაბადების თარიღი
DD.MM.YYYYფორმატის სტრიქონია. - სია მთელ სასტუმროს მოიცავს; ოთახის ან თარიღის ფილტრი არ არსებობს. შედარება თქვენს მხარეს შეასრულეთ და სია დააქეშირეთ.
- პასუხი პერსონალურ მონაცემებს შეიცავს (პირადობის ნომერი, დაბადების თარიღი). შეინახეთ მხოლოდ საჭირო ველები და მოთხოვნა გაგზავნეთ საკუთარი სერვერიდან — არასოდეს სტუმრის მოწყობილობიდან.
ვერსიონირება#
ეს ენდპოინტი HMS-ის სპეციალური API-ების ჯგუფს ეკუთვნის და ვერსიის ნომერი არ აქვს. ახალი ველები შეიძლება გაფრთხილების გარეშე დაემატოს; კლიენტი ისე დაწერეთ, რომ უცნობ ველებს უგულებელყოფდეს. არსებული ველის წაშლა ან მისი მნიშვნელობის შეცვლა წინასწარ ცხადდება ცვლილებების ჟურნალში.