开放平台接入方案
服务器地址
- 正式环境地址: https://api.jabriel.cn
- 测试环境:http://api.fat.jabriel.cn
请求方式
| 参数 | 说明 |
|---|---|
| 传输方式 | Http |
| 提交方式 | 采用post json 的方式进行提交 |
| 数据格式 | 以json提交 |
| 字符编码 | 统一采用UTF8字符编码 |
| 签名算法 | HmacSHA256 |
| 签名要求 | 请求与响应都需要签名 |
| 签名位置 | 写入在http头Authorization中 |
| 判断逻辑 | 先判断http状态, 再判断 code 是否为200, 再判断签名是否正确,最后才为业务判断 |
通用响应
- 接口这边统一会以这个结构返回, 不同的是data数据字段结构.
| 响应 | 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|---|
| code | 通讯代码 | int | 是 | 通用返回200表示成功, 4xx表示客户端错误, 403表示认证失败, 5xx表示系统异常, 一万以上的code为具体的业务异常 |
| msg | 错误信息 | String | 是 | 错误时返回错误内容,code=200时返回ok,其它code时的错误信息 |
| total | 记录数 | int | 是 | 仅当列表响应分页时才会响应记录结果数 |
| data | 数据 | object | 否 | 不同的接口返回的数据也不一样 |
最后编辑: lamb 文档更新时间: 2022-01-21 17:52 作者:lamb