简要描述:
- 对接指引
本文档为印迹平台业务API接入规范,在使用本规范之前,请先仔细阅读“API对接流程”文档。 接入约定
印迹平台API接口采用REST风格,对外暴露HTTP服务。如果没有特殊说明,印迹开放平台API提供基于http协议,post方式,基于json格式的数据访问,数据编码为UTF-8。调用URL规则为:
{API_URL}/{BUSINESS}/{FUNCTION}(具体接口中的请求URL)跟团业务的BUSINESS(业务标识)为tours。
门票业务的BUSINESS(业务标识)为ticket。
签证业务的BUSINESS(业务标识)为visa。
保险业务的BUSINESS(业务标识)为insurance。
单项业务的BUSINESS(业务标识)为loneproduct。
{API_URL}请向印迹支持人员咨询。
本文档中接口请求参数,apiKey和apiSecret请向印迹支持人员获取。
调用参数:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
apiKey | String | 是 | 系统参数。分配给供应商的唯一身份标识 |
apiSecret | String | 是 | 系统参数。请求密匙 |
sign | String | 是 | 系统参数。请求签名 |
currentTimeStamp | String | 是 | 系统参数。时间戳 |
uri | String | 是 | 系统参数。请求的Url |
data | Json | 否 | 业务参数。依赖业务请求数据敏感程度,可能会加密 |
返回结果:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
Success | boolean | 是 | 系统参数。是否请求成功 |
Code | int | 是 | 系统参数。结果码,参见通用公共返回码,以及具体业务的返回码 |
Message | String | 否 | 系统参数.异常时错误信息 |
Data | Json | 否 | 业务参数。处理后的数据 |
接口版本:
版本号 | 制定人 | 制定日期 | 修订日期 |
---|---|---|---|
0.1.0 | 老杨 | 2017-12-06 | 2017-12-06 |
请求完整URL:
请求方式:
- POST
请求头:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
Content-Type | 是 | string | 请求类型: application/json; charset=utf-8 |
Content-MD5 | 是 | string | 请求内容签名 |