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