ავთენტიფიკაცია

Hotspot API ავთენტიფიკაციისთვის ერთ HTTP სათაურს იყენებს: ApiKey. ცალკე შესვლის ეტაპი და ტოკენი არ არსებობს; გასაღები ყოველ მოთხოვნაში იგზავნება.

სათაურები#

POST /public/json/customer/inhotel HTTP/1.1
Host: test.hms.gen.tr
ApiKey: 017f1daf2d139
HotelCode: 1000
Content-Length: 0

საიდან მოდის გასაღები#

გასაღები იქმნება სასტუმროს HMS-ის მართვის პანელში, API გვერდის Custom API ჩანართზე. აღწერის ველი იმის აღსანიშნავადაა, სად გამოიყენება გასაღები; შესაძლებელია რამდენიმე გასაღების შექმნა. იმავე გვერდზე წაშლილი გასაღები მაშინვე ძალას კარგავს.

წარუმატებელი ავთენტიფიკაცია#

თუ სათაური აკლია ან ცარიელია, ან გასაღები HMS-ში ვერ მოიძებნა, ბრუნდება HTTP 401 შემდეგი ტანით:

{
    "success": 0
}

შეცდომის დეტალები არ მოიცემა. შეამოწმეთ ამ თანმიმდევრობით: სათაურის სახელი არის ApiKey, მნიშვნელობა ზუსტად ემთხვევა პანელიდან დაკოპირებულ გასაღებს და გასაღები კვლავ ჩანს პანელის სიაში. 401 პასუხის შემთხვევაში მოთხოვნას ნუ გაიმეორებთ; გასაღების გასწორებამდე შედეგი არ შეიცვლება.

სასტუმროს კონტექსტი#

გასაღები ერთ სასტუმროზეა მიბმული; პასუხი მხოლოდ ამ სასტუმროს სტუმრებს შეიცავს. რამდენიმე სასტუმროს მომსახურე ინსტალაციისთვის გასაღები თითოეული სასტუმროს საკუთარი პანელიდან მიიღეთ და სასტუმროების მიხედვით შეინახეთ. სხვა HotelCode მნიშვნელობის გაგზავნა სხვა სასტუმროს მონაცემებს არ დააბრუნებს; სასტუმროს ყოველთვის გასაღები განსაზღვრავს.

გასაღების დაცვა#

• შეინახეთ გასაღები hotspot სერვერის კონფიგურაციაში ან გარემოს ცვლადში; არასოდეს ჩასვათ იგი captive portal-ის HTML-ში ან კლიენტის მხარის JavaScript-ში.
• კომპონენტი, რომელიც სიას იღებს, სერვერის მხარეს უნდა მუშაობდეს. სტუმრების მოწყობილობებმა HMS-ს პირდაპირ არ უნდა მიმართონ; პასუხი ყველა სტუმრის პირადობის მონაცემებს შეიცავს.
• თუ ეჭვი გაქვთ, რომ გასაღები გაჟონა, წაშალეთ იგი პანელში და ახალი შექმენით. ძველი გასაღები წაშლისთანავე 401 პასუხს დააბრუნებს.