Open API
YSystem Open API 使用 HTTP POST 接口。对外接口路径以 /v1/ 或 /v2/ 开头,集成方应使用对应环境的 API 地址和分配的商户关键字。
API 地址
| 环境 | API 根地址 |
|---|---|
| 开发环境 | https://dev-yapi.ytripos.com/ |
| 正式环境 | https://yapi.ytripos.com/ |
在根地址后添加版本和接口路径。例如,开发环境的 v2 酒店搜索接口为 https://dev-yapi.ytripos.com/v2/hotel/search。
接入步骤
- 向平台申请渠道和 API 凭证。
- 按 请求认证与签名 生成请求头。
- 选择 v1 或 v2 接口,并按照对应版本的字段参考组装 JSON 请求体。
- 对分页、异步任务和业务错误分别处理,不要只依据 HTTP 状态判断订单或预订结果。
API 版本
| 版本 | 适用场景 | 字段参考 |
|---|---|---|
| v1 | 现有酒店、订单、任务和 Webhook 集成 | v1 中文 · v1 English |
| v2 | 酒店、订单、邮轮、字典和 Webhook 的新集成 | v2 |
v1 和 v2 的请求头签名规则一致,但模型和接口路径可能不同。升级版本时请以目标版本的模块文档为准。
接口目录
- 酒店:
hotel/search、hotel/rates、hotel/rateRule、hotel/book - 订单:
order/search、order/analytics、order/cancel;聚合查询见 订单 BI 接口 - v2 订单金额字段与示例:见 订单查询与金额
- 任务:
job/status - 邮轮(v2):
cruise/itinerary/*、cruise/fares、cruise/price、cruise/cabin/*、cruise/meta/*、cruise/book - Webhook:以对应版本的
webhook模块为准
完整接口列表和模型字段请从上方版本参考进入。