接口规则说明
| 版本 | 日期 | 描述 | 作者 |
|---|---|---|---|
| V1.0 | 2019-08-22 | 创建 | 智强 |
协议规则
传输方式:采用HTTP/HTTPS传输
提交方式:采用GET/POST/PUT/DELETE 方式提交
字符编码:UTF-8
接口数据
金额:接口中所有涉及金额字段,数值类型为Long,单位精确到分。如:18 表示 18分。
接口地址
| 系统 | 表头 |
|---|---|
| 接口地址 | https://mch.yintongzaixian.com |
参数规范
- 所有对外参数名称统一,参数命名使用驼峰样式,请求参数采用x-www-form-urlencoded格式发送。
- 服务端返回数据为json格式,参数说明:
| 参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
| code | String | 是 | 6 | 接口返回码 | 0 |
| msg | String | 是 | 128 | 接口返回描述 | 业务处理失败 |
| data | Json | 否 | 接口返回的数据 | {“access_token”:”WDFGDF234DFEWRGG”} |
返回数据参考:
{ "code" : 0, "msg" : "success", "data" : { "appId" : "0695598130314a3682874b51e1022a6d", "appName" : "百汇董村点" } }
安全规范
1、服务端token约束
(1)服务端使用jwt方式生成token,客户端调用鉴权接口,服务端认证通过后,返回生成token数据。
(2)客户端在请求服务端接口时,需要在http请求头中增加iToken参数传递token到服务端,服务端会对该token值的真实性以及有效期进行验证。如:
iToken=eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiIyMDAwMDAwMCIsImNyZWF0ZWQiOjE1MTMwMDIzNjc0MzgsImlkIjoyMDAwMDAwMCwiZXhwIjoxNTEzNjA3MTY3fQ.HOJhm7SXE9D6_cleUMYduZAXUlEz3d78rTwTVv2Vdaxjz_HEyizL73T0aRcGFIHc8Qoni0RMqPBJ_NFXVUbubQ