对接标准接口文档
简述
本文档适用于第三方(主要是商旅平台,在文档中都称为第三方)快速对接每刻满足客户需求,具有以下特点:
- 标准化的接口,展示现有的系统功能,快速对接客户所需字段,以及快速定位问题;
- 切分功能模块,按模块对接开发;
- 一次对接,多企业兼容。
文档结构
本文档接口页面结构如下:
- 接口名称(标题);
- 接口简介,包含接口后缀、HTTP 请求方式(GET/POST)、数据格式(请求响应格式,一般为 Json)、调用接口的主体(第三方/每刻)和接口说明;
- 请求参数;
- 响应结构;
- 示例。
对接流程
以下是差旅平台 TMC 需要对接的接口以及对接接口的顺序:
- 第三方认证,标准化对接按照该接口定义获取 token,并在接下来的请求中带上;
- 每刻认证,如果需要调用每刻接口,需要找对接人获取 platformCode、secretKey和接口前缀,比如开通状态通知接口或者查询子一级城市(全量同步)等。
- 企业开通接口,企业管理员通过开通通知通知第三方需要进行开通,企业开通状态会变成开通中,等待第三方的回调。
- 开通状态通知接口,第三方创建并且维护好企业信息和配置后,可以调用该接口,告诉每刻企业在第三方开通成功,此时企业开通状态改变为已开通。
- 员工同步,企业管理员将通过该接口,将企业的员工信息同步到第三方。
- 申请单同步,员工提交申请单,经过审批后才会推送到第三方,第三方按照申请单上的信息,限制员工预定。
- 订单同步,员工在预定后,第三方生成订单,通过订单接口进入每刻。
- 账单接口,企业对账人可以在每刻界面进行对账,对账数据通过对账相关接口进入每刻。
[info] 建议:
第三方可以优先开发前 7 组接口,覆盖企业的开通、员工同步、申请单推送、单点登录以及消费流水进入每刻生成费用并报销,保证企业正常的预定流程,账单则可以采用线下给到企业。
当企业已经使用过一段时间后,正式的生产环境会产生一定数量的真实订单,再对接账单相关接口,此时可以复制一些数据到测试环境进行联调测试。