Online Booking API
将酒店官网的预订引擎与 HMS 对接:房型与价格列表、日历房态、优惠券、支付和预订推送。
- 基础 URL
https://test.hms.gen.tr- 身份验证
- apiKey / apiSecret → Bearer token
- 格式
- JSON 响应 · 表单或 JSON 请求体
- 范围
- 8 个资源 · 16 个端点
资源#
身份验证
1 个端点访问 Online Booking API 需使用 HMS 签发的合作伙伴凭据。登录端点用 apiKey 和 apiSecret 换取 token,之后的所有请求都在 Authorization: Bearer 请求头中携带该 token。详见身份验证指南。
- POST
/external/public/login
房型与价格
2 个端点为预订引擎搜索结果提供数据的两个端点:房型列表返回指定日期和入住人数下可售的房型、餐食类型及价格;房态返回逐日的可用房量和价格,用于日历视图。
- POST
/external/online/roomType - GET
/external/room/type/hotel/availability
预订
1 个端点客人所选的房型、餐食类型和价格以 BookingPushRQ 结构推送到 HMS。同一端点也可处理取消和修改:将 type 设为 Cancel 或 Modify 即可。端到端流程见预订流程指南。
- POST
/external/online/channel/booking
支付
3 个端点列出酒店在线预订接受的支付方式,并根据所选方式启动支付步骤。各支付方式的处理方法见支付流程指南。
- GET
/external/online/payment/type - GET
/external/payment/company - POST
/external/online/payment/type/{paymentType}
优惠券
1 个端点验证酒店在后台设置的在线折扣优惠券。折扣由您一方计算;推送预订时请发送折后金额。
- POST
/external/online/coupon/search
套餐与附加服务
1 个端点可随预订一起销售的附加服务:客房套餐(与某一房型绑定)和通用套餐(接送、晚餐、Spa)。售出的套餐在预订推送中以 extras[] 发送。
- GET
/external/stock/packages
酒店信息
4 个端点用于填充预订引擎页面框架的数据:联系方式与位置、社交媒体链接、页脚文本(法律条款、酒店简介、Analytics/Ads 代码片段),以及用于发送确认邮件的 SMTP 设置。
- GET
/external/hotel/{hotelID}/contact/info - GET
/external/online/social/media - GET
/external/online/footer - 另有 1 个
基础数据
3 个端点用于表单选项的静态列表:国家、币种和语言。这些数据很少变化,可缓存一天。
- POST
/external/counties - GET
/external/currencies - GET
/external/languages
文档#
入门
- 概览Online Booking API 的用途、基础 URL、流程概要与通用规则。
- 快速入门使用合作伙伴凭据获取 token,并发送第一个房型与价格查询。
- 身份验证使用 apiKey / apiSecret 登录、Bearer token、酒店上下文与 token 有效期。
- 请求与响应表单与 JSON 请求体、success 包装结构、分页、日期与金额格式、HTTP 状态码。
- 错误码message 与 errorCode 取值、身份验证错误及重试建议。