ภาพรวม
Online Booking API เชื่อมต่อระบบจองห้องพัก (booking engine) บนเว็บไซต์ของโรงแรมเข้ากับซอฟต์แวร์โรงแรม HMS ทั้งรายการห้องพักและราคา ห้องว่างตามปฏิทิน การตรวจสอบคูปอง ขั้นตอนการชำระเงิน และการส่งการจองเข้า HMS ล้วนทำผ่าน API นี้ API นี้ออกแบบมาสำหรับเอเจนซีที่พัฒนาระบบจองห้องพักและพาร์ทเนอร์ของ HMS
URL หลัก#
เอนด์พอยต์ทั้งหมดอยู่ภายใต้ URL หลักด้านล่าง ในพาธ /external/… และรับเฉพาะ HTTPS เท่านั้น
https://test.hms.gen.trภาพรวมขั้นตอน#
POST /external/public/loginPOST /external/online/roomTypePOST …/payment/type/{type}POST …/channel/bookingโทเค็นที่ได้จากการเข้าสู่ระบบมีอายุ 7 วันและผูกกับโรงแรมเดียว รายการห้องพักจะส่งคืนห้องที่ขายได้และราคาตามวันที่และจำนวนผู้เข้าพักที่ผู้เข้าพักค้นหา เมื่อผู้เข้าพักเลือกห้องและกำหนดประเภทการชำระเงินแล้ว การจองจะถูกบันทึกลงใน HMS ในรูปแบบ BookingPushRQ คู่มือขั้นตอนการจองจะอธิบายทุกขั้นตอนโดยละเอียด
ทรัพยากร#
| ทรัพยากร | เอนด์พอยต์ |
|---|---|
| การยืนยันตัวตน | POST /external/public/login |
| ห้องพักและราคา | POST /external/online/roomTypeGET /external/room/type/hotel/availability |
| การจอง | POST /external/online/channel/booking |
| การชำระเงิน | GET /external/online/payment/typeGET /external/payment/companyPOST /external/online/payment/type/{paymentType} |
| คูปอง | POST /external/online/coupon/search |
| แพ็กเกจและบริการเสริม | GET /external/stock/packages |
| ข้อมูลโรงแรม | GET /external/hotel/{hotelID}/contact/infoGET /external/online/social/mediaGET /external/online/footerGET /external/online/mail/host |
| ข้อมูลพื้นฐาน | POST /external/countiesGET /external/currenciesGET /external/languages |
กฎทั่วไป#
- ทุกคำขอยกเว้นการเข้าสู่ระบบต้องมีเฮดเดอร์
Authorization: Bearer <token> - เอนด์พอยต์
POSTส่วนใหญ่รับฟิลด์แบบฟอร์ม (application/x-www-form-urlencodedหรือmultipart/form-data) ส่วนการส่งการจองและการเริ่มชำระเงินต้องใช้เนื้อหาแบบ JSON หน้าเอกสารอ้างอิงของแต่ละเอนด์พอยต์จะระบุไว้ว่าใช้แบบใด - การตอบกลับเป็น JSON และมีแฟล็ก
successข้อผิดพลาดตามกฎทางธุรกิจก็ส่งกลับเป็น HTTP200เช่นกัน ดังนั้นให้ตัดสินผลลัพธ์จากsuccessไม่ใช่จากรหัสสถานะ - วันที่อยู่ในรูปแบบ
YYYY-MM-DDจำนวนเงินเป็นสตริงทศนิยมสองตำแหน่ง ("965.00") และสกุลเงินมาจากการตั้งค่าช่องทางออนไลน์ของโรงแรม - พารามิเตอร์
hotelIDต้องตรงกับโรงแรมที่โทเค็นผูกอยู่
เวอร์ชัน#
เอกสารนี้ครอบคลุม HMS API V2 ฟิลด์และเอนด์พอยต์ใหม่อาจถูกเพิ่มโดยไม่แจ้งล่วงหน้า จึงควรเขียนไคลเอนต์ให้ละเว้นฟิลด์ที่ไม่รู้จัก การเปลี่ยนแปลงต่าง ๆ จะแสดงไว้ในบันทึกการเปลี่ยนแปลง