ภาพรวม

Hotspot API ส่งรายชื่อผู้เข้าพักในโรงแรมไปยังระบบ Hotspot (captive portal) สำหรับผู้เข้าพักทุกคนที่เช็กอินแล้วและยังไม่เช็กเอาต์ HMS จะส่งคืนหมายเลขห้อง ชื่อ หมายเลขเอกสารประจำตัว วันเกิด และเวลาเช็กอิน/เช็กเอาต์ ซอฟต์แวร์ Hotspot ใช้รายการนี้เพื่อยืนยันการเข้าสู่ระบบ Wi-Fi ของผู้เข้าพักด้วยหมายเลขห้องและนามสกุล เพื่อปิดการเข้าถึงเมื่อสิ้นสุดการเข้าพัก และเพื่อผูกบันทึกการเข้าใช้งานที่ต้องเก็บตามกฎหมายตุรกีฉบับที่ 5651 เข้ากับตัวบุคคล

URL หลัก#

เอนด์พอยต์อยู่ภายใต้ URL หลักด้านล่าง ในพาธ /public/json/… และรับเฉพาะ HTTPS เท่านั้น

https://test.hms.gen.tr

ภาพรวมขั้นตอน#

คีย์จะสร้างเพียงครั้งเดียวในแผงควบคุมผู้ดูแลของ HMS ของโรงแรม และส่งเป็นเฮดเดอร์ ApiKey ในทุกคำขอ เอนด์พอยต์รายการจะส่งคืนผู้เข้าพักในโรงแรมทั้งหมดในการเรียกครั้งเดียว ซอฟต์แวร์ Hotspot จะจับคู่หมายเลขห้องและนามสกุลที่ผู้เข้าพักกรอกบนพอร์ทัลกับรายการนี้ เปิดบัญชีไว้จนถึงวันเช็กเอาต์ตามแผน และรีเฟรชรายการเป็นระยะเพื่อปิดบัญชีของผู้เข้าพักที่ออกไปแล้ว รายละเอียดอยู่ในคู่มือขั้นตอนการตรวจสอบผู้เข้าพัก

ทรัพยากร#

กฎทั่วไป#

• ทุกคำขอต้องมีเฮดเดอร์ ApiKey ไม่มีขั้นตอนเข้าสู่ระบบและไม่มีโทเค็น
• เรียกเอนด์พอยต์ด้วย POST โดยไม่มีเนื้อหา query string หรือพารามิเตอร์ตัวกรอง
• การตอบกลับเป็น JSON และฟิลด์ success เป็นตัวเลข 1 หรือ 0 เมื่อยืนยันตัวตนไม่สำเร็จ จะได้รับ HTTP 401 พร้อม {"success": 0}
• เวลาอยู่ในรูปแบบ Unix timestamp (วินาที) ส่วนวันเกิดเป็นสตริงรูปแบบ DD.MM.YYYY
• รายการครอบคลุมทั้งโรงแรม ไม่มีตัวกรองตามห้องหรือวันที่ ให้จับคู่ในฝั่งของคุณและแคชรายการไว้
• การตอบกลับมีข้อมูลส่วนบุคคล (หมายเลขเอกสารประจำตัว วันเกิด) ให้จัดเก็บเฉพาะฟิลด์ที่จำเป็น และส่งคำขอจากเซิร์ฟเวอร์ของคุณเองเท่านั้น ห้ามส่งจากอุปกรณ์ของผู้เข้าพัก

การกำหนดเวอร์ชัน#

เอนด์พอยต์นี้อยู่ในกลุ่ม Custom API ของ HMS และไม่มีหมายเลขเวอร์ชัน ฟิลด์ใหม่อาจถูกเพิ่มโดยไม่แจ้งล่วงหน้า จึงควรเขียนไคลเอนต์ให้ละเว้นฟิลด์ที่ไม่รู้จัก การนำฟิลด์ที่มีอยู่ออกหรือการเปลี่ยนความหมายของฟิลด์จะประกาศล่วงหน้าในบันทึกการเปลี่ยนแปลง

ขั้นตอนถัดไป#