请阅读我们的 快速开始指南 来快速上手。该指南会一步步带你完成第一次 API 调用、鉴权以及基本操作。
每次 API 请求都必须在请求头里携带有效的 Hostex-Access-Token。
百居易 OpenAPI 覆盖以下业务域:
| 功能 | 方法 | 端点 | 描述 |
|---|
| 查询房间 | GET | /properties | 列出房间及其详情。支持按 id、group_id、tag_id 过滤。 |
| 查询房间分组 | GET | /groups | 列出房间分组及关联的房间 ID。 |
| 查询标签 | GET | /tags | 列出房间/房型标签及其关联的房间和房型 ID。 |
| 功能 | 方法 | 端点 | 描述 |
|---|
| 查询房型 | GET | /room_types | 列出房型及其详情。支持按 id 和 tag_id 过滤。 |
| 功能 | 方法 | 端点 | 描述 |
|---|
| 查询订单 | GET | /reservations | 查询订单详细信息。 |
| 创建订单 | POST | /reservations | 直接在百居易系统内创建新订单。 |
| 功能 | 方法 | 端点 | 描述 |
|---|
| 查询房间房态 | GET | /availabilities | 查询指定日期范围内房间的房态。 |
| 更新房间房态 | POST | /availabilities | 更新房间的房态(开放/关闭)。 |
| 功能 | 方法 | 端点 | 描述 |
|---|
| 查询渠道日历 | POST | /listings/calendar | 查询多个房源的渠道日历详情。 |
| 更新渠道库存 | POST | /listings/inventories | 更新渠道侧房源的库存。 |
| 更新渠道价格 | POST | /listings/prices | 更新渠道侧房源的售价。 |
| 更新渠道限制 | POST | /listings/restrictions | 更新渠道侧房源的入住限制。 |
| 功能 | 方法 | 端点 | 描述 |
|---|
| 查询会话 | GET | /conversations | 列出房客会话及咨询。 |
| 查询会话详情 | GET | /conversations/{conversation_id} | 查询某个会话的消息和详情。 |
| 发送消息 | POST | /conversations/{conversation_id} | 向房客发送文本或图片消息。 |
| 功能 | 方法 | 端点 | 描述 |
|---|
| 查询评价 | GET | /reviews | 查询评价,等同于百居易评价页面。 |
| 创建评价 | POST | /reviews/{reservation_code} | 针对某笔订单提交评价或回复。 |
| 功能 | 方法 | 端点 | 描述 |
|---|
| 查询任务 | GET | /tasks | 列出排期任务(保洁、维修、接待、客房服务、其他)。支持按日期、员工、房间、类型、状态过滤。 |
| 查询员工 | GET | /staffs | 列出排期员工(保洁等)用于任务分配与跟踪。 |
错误通过响应体的 request_id、error_code、error_msg 反馈。详见 错误码。
所有响应都遵循统一的 JSON 信封格式,结构稳定可预期。
通过 Webhook 实时接收业务事件推送。详细用法请参考 Webhook 使用指南。