烈熊开放接口基础文档
烈熊开放接口基础文档
本文档提供权益SaaS平台API接口 v1 版本
下面接口都会使用我们提供的如下信息
- appId 用于区分客户
- appSecret 密钥,用于加密
正式api地址 https://interests-open.billbear.vip 测试api地址 https://interests-open-test.billbear.vip
开发必读
测试/生产环境都需要添加IP白名单,IP白名单添加后需要等待至少5分钟生效。 测试/生产环境请求地址需要联系商务邮件发送 当修改IP白名单之后需要重新获取授权才会生效
协议规则
1)传输方式
为保证交易安全性,采用HTTPS传输
2)基本流程
流程: 获取accessToken -> 通过header[authorization]带入accessToken调用其他接口
- 接口统一采用HTTP的POST/JSON方式请求。
- 输入和输出参数都采用UTF-8编码。
- 接口处理成功返回 HttpCode 是否是 200 然后判断响应内容 code 是否是 0 才能使用 data 内数据。
- 接口处理失返返回 HttpCode 是否是 200 然后判断响应内容 code 不是 0 则message错误原因。
- 所有 Request ContentType 都是 application/json
- 需要身份认证的接口需要携带 Authorization 头部 Bearer + AccessToken; Bearer 有一个空格需要注意
- 需要双重身份的接口需要携带双令牌在 Authorization 头部 Bearer + 客户AccessToken/会员AccessToken; Bearer 有一个空格需要注意, 后面的客户和会员令牌有一个斜杠分割
- 所有接口人民币单位都是分,百分比单位都是 1/100
请求后直接返回结果json(没有外层包装) 通过 http statusCode 表示正确和错误,200成功,其他异常:422参数错误,500服务器内部错误
3)错误码描述
codes | 问题描述 | 备注 |
---|---|---|
0001 | 参数错误 | 具体内容查阅返回的message字段 |
0009 | 授权失败 | 系统内部调用异常联系管理员或查看返回的message字段 |
0008 | 签名错误 | 请检查签名生成规则,并重试 |
4001 | IP 不在白名单 | 请联系烈熊方技术添加请求ip白名单 |
401 | 令牌错误 | 头部携带的AccessToken失效或者错误 |
未完待续 | 未完待续 | 未完待续 |