API调用说明

---

概述

磐河旅行分销开放平台（以下简称磐河）提供旅游类全频道资源全流程（指从查询到预订再到退、改一条龙闭环服务流程)API，将原本复杂的旅游业务简化成标准、统一的API服务开放给合作的分销商。分销商使用这些服务，查询各种业务资源，发起和接收订单信息，查询业务相关信息。并在API公共服务的基础上，灵活实现产品的展现和业务操作，为终端用户提供更丰富、更及时、更准确的服务，从而实现效益最大化，与磐河实现双赢。

API术语

名称	解释说明
API	Application Programming Interface应用程序接口。
appKey	分销商API请求唯一身份标识，申请API接入后即可获得。
secretKey	请求密钥，申请API接入后即可获得。用于验签和加解密。
sign	签名，用来防止请求被伪造或篡改。
MD5	磐河开放平台使用的校验算法。

调用约定

磐河旅行开放接口采用REST风格，对外暴露HTTP服务。如果没有特殊说明，磐河API提供基于http协议，post方式，基于json格式的数据访问，数据编码为UTF-8。有两种调用方式：
1. 分销商主动发起，磐河开放平台API的请求。
2. 磐河发起，回调分销商系统的请求。

调用流程

分销商调用磐河以及磐河调用分销商，同样使用同步调用，调用方需等待被调用方处理返回。
1. 请求流程

2. 回调流程

数据格式

1.1 分销商调用磐河请求参数
简单查询类请求直接get携带查询字符串请求参数即可，如机票查询接口：?appKey=您申请的APPKEY&fromCityCode=SHA&toCityCode=HFE&fromDate=2020-04-15
复杂业务类请求参数post，json格式（需要指定Content-Type 为"application/json; charset=utf-8"）如下单请求参数。
1.2 分销商调用磐河返回数据，一律json格式。返回结果包含以下字段：

参数名称	类型	必填	说明
success	bool	是	系统参数。是否请求成功
msg	string	是	系统参数。当请求失败时给出的错误提示信息
data	object	否	业务参数。处理后的数据

2.1 磐河调用（回调）分销商请求参数
磐河直接发起get请求，如：分销商的回调地址?orderNo=123&orderStatus=2
2.2 磐河调用（回调）分销商返回参数
分销商接受到磐河的回调请求后，直接响应字符串即可。成功返回：success，失败返回：fail 。