概览

Welcome to the Hostex API, where seamless integration meets comprehensive management of property and reservation systems. Our API provides a powerful suite of features for developers looking to automate and interact with the Hostex platform.

快速开始

请阅读我们的 快速开始指南 来快速上手。该指南会一步步带你完成第一次 API 调用、鉴权以及基本操作。

鉴权

每次 API 请求都必须在请求头里携带有效的 Hostex-Access-Token

主要能力

百居易 OpenAPI 覆盖以下业务域:

房间

功能方法端点描述
查询房间GET/properties列出房间及其详情。支持按 idgroup_idtag_id 过滤。
查询房间分组GET/groups列出房间分组及关联的房间 ID。
查询标签GET/tags列出房间/房型标签及其关联的房间和房型 ID。

房型

功能方法端点描述
查询房型GET/room_types列出房型及其详情。支持按 idtag_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_iderror_codeerror_msg 反馈。详见 错误码

响应格式

所有响应都遵循统一的 JSON 信封格式,结构稳定可预期。

Webhook

通过 Webhook 实时接收业务事件推送。详细用法请参考 Webhook 使用指南