目录

概述

PC Integration API  允许 PMS 公司集成 DerbySoft Property Connector,用于 ARI、预订和住宿记录的数据交换,以及创建酒店、房价 和 房型。 PMS 厂商可以通过德比软件PC Integration API  连接德比软件渠道分销服务,增强 PMS 厂商渠道分销服务。 


在房价、房量、可用性 (ARI) 和订单的数据交互上德比软件采用是“推/推”模型。


  1. PMS 将酒店信息推送至德比软件,在Property Connector里创建酒店。
  2. PMS 将房价&房型数据推送至德比软件,在Property Connector里创建产品。
  3. PMS 将 ARI 推送至德比软件,德比软件会将数据异步存储到数据库中。
  4. PMS推送渠道设置信息至德比软件 ,在Property Connector中创建或更新指定渠道的设置。
  5. PMS推送渠道mapping至德比软件,在Property Connector中更新渠道和酒店产品对应关系。
  6. 德比软件将分销商的预订信息推送到 PMS,并将确认或错误信息直接反馈给分销商。
  7. PMS 将入住信息推送至德比软件,德比软件会生成相应的数据报告。
  8. 德比软件将分销商的消息推送到PMS。


 类别

接口

推送方向

使用场景

说明

酒店信息Update HotelPMS →德比软件创建或更新酒店信息
静态信息
Update RoomClassPMS →德比软件创建或更新房型类别
Update RoomType
PMS → 德比软件
创建或更新房型信息

Update RatePlanPMS →德比软件创建或更新房价计划

Update FeePMS →德比软件创建或更新税费规则

Update ProductPMS →德比软件创建或更新房型-房价计划组合

房价、房量、房态

Update Rate

PMS → 德比软件

更新房价


Update Inventory

PMS → 德比软件 

更新房量


Update Availability

PMS → 德比软件 

更新房态


渠道管理Update ChannelSetting

PMS → 德比软件 


更新渠道设置渠道激活与渠道更新
Update ChannelMapping

PMS → 德比软件 


更新渠道与酒店的产品对应关系对于在渠道端完成酒店、产品映射的渠道,渠道产品id和PMS产品id需保持一致
ChannelProduct Query

PMS → 德比软件 


获取最新渠道产品信息仅适用于需要在酒店端完成酒店、产品映射的渠道,包括:Agoda, Booking.com和Expedia
订单

Live Check

德比软件  → PMS


检查实时可用性

Book

德比软件  → PMS

预订新订单


Modify

德比软件  → PMS

修改订单

Cancel

德比软件  → PMS

取消订单


Update Reservation Status

PMS → 德比软件

订单状态更新

心跳监测

Ping

德比软件  → PMS

监测接口是否正常运行

帐户令牌

Token Refresh

PMS → 德比软件

获取和刷新令牌

消息Send Message 

德比软件  → PMS

发送新消息
仅适用于Airbnb渠道


酒店创建信息流

产品创建信息流

ARI消息流


渠道管理信息流

订单消息流

消息信息流


安全与认证

PC Integration API 使用Bearer Token处理访问身份验证。我们的系统在调用API服务时验证每条消息。请联系 [email protected]获取Client ID和Client Secret,同时集成到我们的对接中并通过调用Token Obtain&Refresh接口获取bearer token。

以下为调用示例:

POST /pcapigateway/tunnel/{accountId}/rate HTTP/1.1
Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc
Accept-Encoding: gzip
Content-Type: application/json;charset=utf-8

PC Integration API  经认证符合 PCI-DSS 标准和 GDPR,我们建议 PMS 厂商也通过认证。

重要信息:
我们的系统通过 HTTPS 支持 TLSv1.2 及以上版本,请确保您的应用程序与之兼容。


JSON 服务

PC Integration API 基于 JSON restful API 下设计,该 API 遵循 RFC4627 规范。为了确保我们的应用程序可以正确解析您的请求,请在您的 HTTPS 请求中添加  Content-Type: application/json;charset=utf-8”

重要信息:
UTF-8 是我们唯一支持的字符编码和解码字符集,确保您的应用程序可以接受一些非拉丁字符,如客人姓名、注释等。


消息头

每个请求和响应中都有一个共同的消息头 (Message Header),用以跟踪 PMS 和德比软件之间的交互。德比软件将它们记录在日志系统中用于进行故障排除。建议您在 PMS 系统也可以记录它们,并将它们提供给我们,以便将来进行问题调查。


字段类型是否必填描述说明

echoToken

字符串唯一的 ID,长度小于 50 个字符。每个交易唯一的跟踪 ID,并且必须在请求和响应消息的交易中相同。
timeStampyyyy-MM-dd'T'HH:mm:ss.SSSZUTC 时间。2018-06-27T17:09:04.674Z
version字符串

消息的版本。/



终端地址


端点地址说明
测试环境https://pcendpoint.derbysoft-test.com/pcapigateway/tunnel/{accountId}应用于房态、房价、房量和订单状态更新
https://pcendpoint.derbysoft-test.com/pcapigateway/profile/{accountId}
应用于酒店信息、静态信息、渠道
https://pcendpoint.derbysoft-test.com/pcapigateway/account/token
应用于帐户令牌
生产环境https://pcendpoint.derbysoftsec.com/pcapigateway/tunnel/{accountId}
应用于房态、房价、房量和订单状态更新
https://pcendpoint.derbysoftsec.com/pcapigateway/profile/{accountId}
应用于酒店信息、静态信息、渠道
https://pcendpoint.derbysoftsec.com/pcapigateway/account/token
应用于帐户令牌



IP 地址

如果您必须设置 IP 白名单,请使用以下IP地址:


端点

地址

说明

测试环境

52.83.237.180

 /

生产环境

34.210.91.128/26

 /

34.223.15.0/25

 /

43.192.1.64/28
 /
3.0.5.64/26
 /



成功与失败响应

PC Integration API 遵循 HTTP 状态代码标准,以指示成功响应或失败响应。HTTP 状态代码 200 表示请求在服务器中处理良好,HTTP 状态代码 500 表示发生了错误。


请遵循此标准,因为它有助于与某些第三方监控系统和跟踪系统集成。


错误处理

希望您的 PMS 具有强大的错误处理流程,包括排队机制和稳健的重试策略。


错误响应应包含错误简要描述,有利于我们的团队排查问题。


HTTP 状态代码

描述

401

未经授权 的表示该请求尚未应用,因为它缺少目标资源的有效身份验证凭据。

403

禁止 表示服务器理解请求但拒绝授权。

404

未找到 表示服务器找不到请求资源。

405

不允许的方法 表示请求方法由服务器知道,但目标资源不支持。

429

请求太多 表示用户在给定时间内发送了太多的请求("速率限制")。

500

服务器错误 表示服务器遇到意外情况,无法满足请求。在这种情况下,大多会出现一些业务错误,例如我们这边的"无效领域"。您的应用程序必须解析响应才能获得正确的错误详细信息。


错误详细信息将包括 错误代码、 错误消息 和响应中的标头。请参阅以下示例:

{
"header": {
"echoToken": "f67ade36-0b83-49cf-bfb1-b932c45b7d34",
"timeStamp": "2018-06-27T17:09:04.674Z",
"version": "1.00"
},
"errorCode": "InvalidField",
"errorMessage": "Invalid token"
}


错误响应

发生业务错误时常见的错误响应。


字段

类型

是否必填

描述

说明

errorCode

字符串

错误代码

/

errorMessage

字符串

错误信息

/
注意事项:
错误响应始终与消息标题一起出现,并且仅显示在 HTTP 状态代码 500 中。