接口说明
<h4>文档作用</h4>
<p>sweet 项目对接</p>
<h4>接口域名</h4>
<p>请联系技术索取</p>
<h4>名词解释</h4>
<ul>
<li>session
<ul>
<li>登录成功后获取, 用来登录服务端的验证字符串, 同时也是访问平台相关接口的身份校验码. 客户端需要进行本地持久化存储.</li>
</ul></li>
<li>刷新session
<ul>
<li>session在一定期限后会过期, 无法用来登录服务端, 所以建议客户端在每次启动APP时主动调用刷新Session接口进行无感登录, 同时更新本地session. </li>
</ul></li>
</ul>
<h4>身份验证</h4>
<p>部分接口需要身份验证, 客户端需要在 HTTP请求头 增加 <code>Authorization</code>: <code>Bearer {session值}</code>, 供平台端识别. </p>
<pre><code># HTTP Header示例
&quot;Authorization&quot;:&quot;Bearer 28|RKKZ9T9T7fZF0kXaAAVcJejzWhMpQyn2WdcbQm6B&quot;</code></pre>
<h4>异常响应</h4>
<p>> 接口会抛出<code>422</code>等非200的HTTP状态码, 同时返回数据中 code 显示具体业务错误码 </p>
<pre><code># demo
{
&quot;message&quot;: &quot;缺少必要参数&quot;,
&quot;code&quot;: 422,
&quot;data&quot;: []
}</code></pre>
<h4>通用传参</h4>
<p>客户端与本平台发送请求时, 需要在<code>HTTP请求头</code>中携带如下参数, 供平台使用, 方便后期扩展</p>
<table>
<thead>
<tr>
<th style="text-align: center;">Key</th>
<th style="text-align: center;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: center;">AppPackage</td>
<td style="text-align: center;">APP包名</td>
</tr>
<tr>
<td style="text-align: center;">AppVersion</td>
<td style="text-align: center;">APK版本</td>
</tr>
<tr>
<td style="text-align: center;">AppHotVersion</td>
<td style="text-align: center;">资源版本</td>
</tr>
</tbody>
</table>
<h6>业务错误码说明</h6>
<table>
<thead>
<tr>
<th style="text-align: center;">返回码</th>
<th style="text-align: center;">说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: center;">401</td>
<td style="text-align: center;">身份验证未通过</td>
</tr>
<tr>
<td style="text-align: center;">422</td>
<td style="text-align: center;">其他错误, 请查看message字段返回文本</td>
</tr>
</tbody>
</table>