通用接口规范
1、接口规范:
1.1通用类型说明
类型 | 说明 | 规则 |
---|---|---|
DateTime | 时间日期类型 | YYYY-MM-DD HH:mm:ss |
Date | 日期类型 | YYYY-MM-DD |
1.2通用接口规范
URL | 第三方提供 |
---|---|
Method | POST / application/x-www-form-urlencoded |
参数名称 | 类型 | 必填 | 说明 |
---|---|---|---|
serviceName | String | 是 | 接口名称 |
version | String | 否 | 接口版本号默认1.0 |
bizContent | String | 否 | 接口请求参数json字符串 |
format | String | 是 | bizContent格式固定json |
charset | String | 是 | 固定UTF8 |
timestamp | Datetime | 是 | 请求时间 |
channelCode | String | 是 | 渠道Code |
signType | String | 是 | 固定MD5 |
sign | String | 是 | 参照加解签规则 |
参数名称 | 类型 | 必填 | 说明 |
---|---|---|---|
resultCode | String | 是 | 请求结果code,0:成功,其他失败 |
resultDesc | String | 否 | 请求结果描述 |
bizContent | String | 否 | 接口请求响应参数json字符串,无固定格式,根据业务而定 |
format | String | 是 | bizContent格式固定json |
charset | String | 是 | 固定UTF8 |
timestamp | Datetime | 是 | 响应时间 |
signType | String | 是 | 固定MD5 |
sign | String | 是 | 参照加解签规则 |
参数名称 | 类型 | 必填 | 说明 |
---|---|---|---|
channelUserId | String | 是 | 第三方用户唯一标识 |
custId | Long | 否 | 最福利用户标识 |
phone | String | 是 | 用户手机号码 |
name | String | 是 | 用户姓名 |
String | 否 | 用户邮箱 |
1.3加解签规则
加签规则(排除sign,signType)
请求参数 s=XXXX,b=XXXX,a=XXXX
1.构建签名串:
对请求参数按照字母升序排序, a=XXXX,b=XXXX,s=XXXX
对参数名称,参数值utf8 进行URLEncodeing 且使用&拼接成参数串 a=XXXX&b=XXXX&s=XXXX
参数串+appKey
2.使用MD5算法对以上签名串进行加签,从而获取sign.ps:使用UTF8字符集
3.将sign作为请求参数,signType=MD5.
验签规则(排除sign,signType)
请求参数s=YYYY,b=YYYY,a=YYYY,sign=ab6e81f0adc128,signType=MD5
1.构建验签串
请求参数除sign按照字母升序排序a=YYYY,b=YYYY,s=YYYY
对参数名称,参数值utf8 进行URLEncodeing 且使用&拼接成参数串 a=YYYY&b=YYYY&s=YYYY
参数串+appKey
2.使用MD5算法对以上签名串 进行加签,从而获取targetSign.ps:使用UTF8字符集
3.如果sign==targetSign验签成功.
修改于 2024-11-01 06:24:58