接口设计模板
匿名 · 更新于 2017/12/22
xxxxx接口文档 v1.0
| 版本变更记录 | |||
| 版本号 | 日期 | 变更人 | 变更摘要 |
| v1.0 | 2017-11-24 | xxx | 1.0接口文档初始化 |
| 签名密钥(signkey)及签名(sign)计算规则说明 | ||
| 说明:签名密钥(signkey)用于所有接口的签名,会随着接口版本的迭代而变更,不同的商户在同一接口版本下的密钥不同,商户管理员可以在商户管理后台获得或者重置对应接口版本的签名密钥,签名计算规则:接口所有请求参数按照参数名正序排列,然后将所有排列后的参数的值连接为字符串,进行md5加密,md5加密后的字符串连接签名密钥,进行二次md5加密,例如:接口A需要传递参数name = “365分利”和 age = 8,那么请求接口的时候除了必要参数(a、b)之外,还需要传递签名sign=md5(md5(age+name)+signkey), 手动签名密钥生成地址:http://suijimimashengcheng.51240.com/ 规则:数字、大小写字母、!@#$%^&* 随机生成32位字符串 |
||
| 平台 | 版本号 | signkey |
| 商家A | 1.0.0 | 5ZXP1IUYZpwgQcjVY!dK2KxZw&!EhH#^ |
| 商家B | 1.0.0 | NYee9x0Fuip*w2naf7BRF8pbvZMORYJQ |
| 接口整体规则 | ||||
| 所有接口公共请求参数 | ||||
| 参数 | 是否必须 | 说明 | ||
| seller_id | 是 | 商家ID | ||
| version | 是 | 版本,以接口发布版本为准,如:1.0.0 | ||
| time | 是 | 时间(时间戳格式如:) | ||
| sign | 是 | 查看签名计算规则 | ||
| 所有接口返回结果JSON格式 | ||||
| 说明:接口统一使用code/msg/data的形式传递数据 { "code": "", "msg": "", "data": "" } |
||||
| 字段 | 意义 | |||
| code | 数据的正确性判断,1为成功,2为签名(sign)不正确,3为当前接口不兼容当前的版本 其他的为对应错误码,可以到错误码结果查看 | |||
| msg | 错误说明 | |||
| data | 对应每个接口的具体数据 | |||
| 其他 | ||||
| 接口测试服务器 | http://testapi.365fenli.com | |||
| 接口正式服务器 | http://api.365fenli.com | |||
1 公共模块
1.1 发送短信验证码(示例)
1.1.1 请求调用说明
| 接口说明:通过短信验证码登录(注册)前需要先请求该接口,获取验证码 http请求方式: POST /myMember/sendSms.api |
1.1.2 请求参数说明
| 参数 | 是否必须 | 说明 |
| phone | 是 | 手机号(账号) |
| send_type | 是 | 请求类型 1登录(注册) 2 第三方账号绑定 3 找回密码 |
| open_id | 否 | 第三方用户标识 如果type为2 那么该参数必须 |
| third_type | 否 | 第三方标识符 1 微信 2 QQ 3新浪微博 如果type为2 那么该参数必须 |
1.1.3 返回说明
正常情况下,服务器返回下述JSON数据包| { "code": 1, "msg": "短信发送成功!", "data": {} } |
1.1.4 返回参数说明(data中的数据)
| 参数 | 说明 |
附录 全局返回码说明
| 返回码 | 说明 |
| 1 | 成功 |
| 2 | 签名不正确 |
| 3 | 当前接口不兼容当前版本 |
