ภาพรวม

Online Booking API เชื่อมต่อระบบจองห้องพัก (booking engine) บนเว็บไซต์ของโรงแรมเข้ากับซอฟต์แวร์โรงแรม HMS ทั้งรายการห้องพักและราคา ห้องว่างตามปฏิทิน การตรวจสอบคูปอง ขั้นตอนการชำระเงิน และการส่งการจองเข้า HMS ล้วนทำผ่าน API นี้ API นี้ออกแบบมาสำหรับเอเจนซีที่พัฒนาระบบจองห้องพักและพาร์ทเนอร์ของ HMS

URL หลัก#

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

URL หลักของ API
https://test.hms.gen.tr

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

1เข้าสู่ระบบPOST /external/public/login
2ห้องพักและราคาPOST /external/online/roomType
3การชำระเงินPOST …/payment/type/{type}
4การจองPOST …/channel/booking

โทเค็นที่ได้จากการเข้าสู่ระบบมีอายุ 7 วันและผูกกับโรงแรมเดียว รายการห้องพักจะส่งคืนห้องที่ขายได้และราคาตามวันที่และจำนวนผู้เข้าพักที่ผู้เข้าพักค้นหา เมื่อผู้เข้าพักเลือกห้องและกำหนดประเภทการชำระเงินแล้ว การจองจะถูกบันทึกลงใน HMS ในรูปแบบ BookingPushRQ คู่มือขั้นตอนการจองจะอธิบายทุกขั้นตอนโดยละเอียด

ทรัพยากร#

ทรัพยากรเอนด์พอยต์
การยืนยันตัวตนPOST /external/public/login
ห้องพักและราคาPOST /external/online/roomType
GET /external/room/type/hotel/availability
การจองPOST /external/online/channel/booking
การชำระเงินGET /external/online/payment/type
GET /external/payment/company
POST /external/online/payment/type/{paymentType}
คูปองPOST /external/online/coupon/search
แพ็กเกจและบริการเสริมGET /external/stock/packages
ข้อมูลโรงแรมGET /external/hotel/{hotelID}/contact/info
GET /external/online/social/media
GET /external/online/footer
GET /external/online/mail/host
ข้อมูลพื้นฐานPOST /external/counties
GET /external/currencies
GET /external/languages

กฎทั่วไป#

  • ทุกคำขอยกเว้นการเข้าสู่ระบบต้องมีเฮดเดอร์ Authorization: Bearer <token>
  • เอนด์พอยต์ POST ส่วนใหญ่รับฟิลด์แบบฟอร์ม (application/x-www-form-urlencoded หรือ multipart/form-data) ส่วนการส่งการจองและการเริ่มชำระเงินต้องใช้เนื้อหาแบบ JSON หน้าเอกสารอ้างอิงของแต่ละเอนด์พอยต์จะระบุไว้ว่าใช้แบบใด
  • การตอบกลับเป็น JSON และมีแฟล็ก success ข้อผิดพลาดตามกฎทางธุรกิจก็ส่งกลับเป็น HTTP 200 เช่นกัน ดังนั้นให้ตัดสินผลลัพธ์จาก success ไม่ใช่จากรหัสสถานะ
  • วันที่อยู่ในรูปแบบ YYYY-MM-DD จำนวนเงินเป็นสตริงทศนิยมสองตำแหน่ง ("965.00") และสกุลเงินมาจากการตั้งค่าช่องทางออนไลน์ของโรงแรม
  • พารามิเตอร์ hotelID ต้องตรงกับโรงแรมที่โทเค็นผูกอยู่

เวอร์ชัน#

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

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