通过HTTP,可使用POST、GET方式请求接口,统一返回JSON数据格式
1、公共参数
参数名 | 类型 | 备注说明 | 必填 |
---|---|---|---|
token | varchar | 用户在登录后的授权码 | 与用户相关必选 |
srchn | int | 来源大渠道 | 可选 |
spchn | int | 来源小渠道 | 可选 |
2、业务参数
自行根据业务规划定义
参数名 | 类型 | 备注说明 | 必填 |
---|---|---|---|
参数1 | |||
参数2 |
3、参数签名
使用MD5签名,产生一个sign参数,累加到请求参数中
sign = md5(参数A=数值A&参数B=数值B&nonce=xxxx&key=xxxx)
红色部分:业务参数,按参数KEY由A-Z0-9排序
蓝色部分:参与签名的临时混淆字符(随时生成)
绿色部分:由内部分配的一串私有字符串,一般20位+
GET方式: http://dnet.com/api/sup/product/info?pid=xxx&token=xxxx&nonce=xxx&sign=xxxx
POST方式:在原有POST参数之上,额外增加 nonce 和 sign 参数,一起提交
4、请求Header头
支持在请求header里面自定义的参数
5、请求回应
只有在HTTP状态为200时,才能正常返回结果,其它HTTP状态需要在应用端自行处理。
正常数据回应:
{
status: 200,
data: {} | [{},{}]
}
注:status 固定值为 200, data 是返回的数据结果,可能为字符、一维数组、多维数组。
字符时:
{
status: 200,
data: 'ok'
}
一维数组时:
{
status: 200,
data: {key: value}
}
多维数组时:
{
status: 200,
data: [{key1: value1, key2: value2},{key1: value1, key2: value2}]
}
异常数据回应:<br />
{
status: 4001,
msg: '错误信息描述'
}
注:status 为异常代码,具体看相应模块定义;msg 为具体错误描述
6、已定义错误码
错误代码 | 备注说明 |
---|---|
9001 | 找不到相应路由 |
9002 | 找不到相应类 |
1001 | 找不到相关数据 |
1002 | 超出权限范围 |
1008 | 数据已被使用 |
1009 | 数据已经存在 |
1010 | 数据缺少 |
1011 | 数据已处理完成 |
1012 | 参数错误 |
1013 | 缺少参数 |
1014 | 签名错误 |
1015 | 密码不能为空 |
1016 | 新密码不相同 |
1017 | 密码长度不符合规范 |
1201 | 新增数据失败 |
1202 | 更新数据失败 |
1203 | 删除数据失败 |
1301 | 超出时间范围 |
1302 | 超出允许编辑范围 |
1303 | 数据不允许删除 |
1304 | 数据不允许操作 |
1305 | 数据不允许使用 |
2011 | 未登录状态 |
2012 | 未绑定手机号码 |
2013 | 未缴纳保证金 |
2014 | 未微信授权 |
2021 | 登录失败 |