Tổng quan
Online Booking API kết nối công cụ đặt phòng trên website riêng của khách sạn với Phần mềm khách sạn HMS. Danh sách phòng và giá, phòng trống theo lịch, kiểm tra mã giảm giá, bước thanh toán và việc gửi đặt phòng vào HMS đều đi qua API này. API được thiết kế cho các agency xây dựng công cụ đặt phòng và cho các đối tác của HMS.
URL gốc#
Tất cả endpoint nằm dưới URL gốc bên dưới, trong đường dẫn /external/…. Chỉ chấp nhận HTTPS.
https://test.hms.gen.trTóm tắt luồng#
POST /external/public/loginPOST /external/online/roomTypePOST …/payment/type/{type}POST …/channel/bookingToken nhận được khi đăng nhập có hiệu lực 7 ngày và gắn với một khách sạn. Danh sách phòng trả về các phòng có thể bán và giá cho ngày và số khách mà khách đã tìm; sau khi khách chọn phòng và hình thức thanh toán đã được xác định, đặt phòng được ghi vào HMS dưới dạng BookingPushRQ. Hướng dẫn Luồng đặt phòng trình bày chi tiết từng bước.
Tài nguyên#
| Tài nguyên | Endpoint |
|---|---|
| Xác thực | POST /external/public/login |
| Phòng và giá | POST /external/online/roomTypeGET /external/room/type/hotel/availability |
| Đặt phòng | POST /external/online/channel/booking |
| Thanh toán | GET /external/online/payment/typeGET /external/payment/companyPOST /external/online/payment/type/{paymentType} |
| Mã giảm giá | POST /external/online/coupon/search |
| Gói dịch vụ và dịch vụ bổ sung | GET /external/stock/packages |
| Thông tin khách sạn | GET /external/hotel/{hotelID}/contact/infoGET /external/online/social/mediaGET /external/online/footerGET /external/online/mail/host |
| Danh mục | POST /external/countiesGET /external/currenciesGET /external/languages |
Quy tắc chung#
- Mọi yêu cầu, trừ đăng nhập, đều mang header
Authorization: Bearer <token>. - Phần lớn endpoint
POSTnhận trường form (application/x-www-form-urlencodedhoặcmultipart/form-data). Gửi đặt phòng và bắt đầu thanh toán yêu cầu nội dung JSON. Trang tham chiếu của từng endpoint cho biết định dạng cần dùng. - Phản hồi ở dạng JSON và có cờ
success. Lỗi quy tắc nghiệp vụ cũng được trả về với HTTP200; hãy đánh giá kết quả dựa vàosuccess, không dựa vào mã trạng thái. - Ngày có dạng
YYYY-MM-DD, số tiền là chuỗi có hai chữ số thập phân ("965.00"), và đơn vị tiền tệ lấy từ cài đặt kênh trực tuyến của khách sạn. - Tham số
hotelIDphải trùng với khách sạn mà token được gắn với.
Phiên bản#
Tài liệu này dành cho HMS API V2. Trường và endpoint mới có thể được bổ sung mà không báo trước; hãy viết client sao cho bỏ qua các trường không xác định. Các thay đổi được liệt kê trong nhật ký thay đổi.