开发约定
<h3>请求前缀地址</h3>
<p><code>https://2025vip.haswallow.com/supervise-api</code></p>
<hr />
<h3>自定义数据头</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">关键字</th>
<th>说明</th>
<th>示例值</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">Authorization</td>
<td>身份校验令牌</td>
<td>e47085904e8302d6c48fc566cc43b5ef</td>
</tr>
</tbody>
</table>
<ul>
<li>除登录接口外所有接口均需要登录验证</li>
</ul>
<hr />
<h3>请求方法(method)</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">method</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">GET[资源获取]</td>
</tr>
<tr>
<td style="text-align: left;">POST[资源创建/更新/删除]</td>
</tr>
</tbody>
</table>
<h3>请求数据类型(content type)</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">数据类型</th>
<th>请求方式</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">url-params</td>
<td>GET</td>
</tr>
<tr>
<td style="text-align: left;">multipart/form-data</td>
<td>POST[仅文件上传]</td>
</tr>
<tr>
<td style="text-align: left;">application/json</td>
<td>POST</td>
</tr>
</tbody>
</table>
<h3>关于列表检索过滤</h3>
<ul>
<li>带有分页的列表接口,分页字段为 <code>page 页码</code> <code>list_rows 每页条数</code>,接口文档中不额外描述.</li>
</ul>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">校验规则</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">page</td>
<td style="text-align: left;">>:0</td>
<td style="text-align: left;">int</td>
<td>页码</td>
</tr>
<tr>
<td style="text-align: left;">list_rows</td>
<td style="text-align: left;">>:0</td>
<td style="text-align: left;">int</td>
<td>每页条数</td>
</tr>
</tbody>
</table>
<ul>
<li>字段过滤行为
<ul>
<li>普通kv为全等过滤,如 <code>merchant_uid=2411273404800111</code></li>
<li>以 <code>_datetime</code> <code>_date</code> 结尾的日期类型字段范围过滤使用特定格式,如 <code>create_datetime=[&quot;2025-02-11 00:00:00&quot;,&quot;2025-02-11 23:59:59&quot;]</code></li>
<li>单字段下需要多值过滤时(in查询)使用特定格式,如 <code>merchant_uid=[&quot;2411273404800111&quot;,&quot;2411273404800112&quot;]</code></li>
</ul></li>
</ul>
<h3>返回通用格式结构</h3>
<pre><code>{
&quot;code&quot;: 0,//状态码
&quot;message&quot;: &quot;消息文本&quot;,
&quot;data&quot;: 数据内容
}</code></pre>
<h3>全局code状态码:</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">code</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">0</td>
<td>成功</td>
</tr>
<tr>
<td style="text-align: left;">1</td>
<td>失败</td>
</tr>
<tr>
<td style="text-align: left;">40110</td>
<td>登录失效/未登录</td>
</tr>
<tr>
<td style="text-align: left;">40200</td>
<td>数据校验失败</td>
</tr>
<tr>
<td style="text-align: left;">50500</td>
<td>服务器异常</td>
</tr>
</tbody>
</table>
<h3>响应头</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">关键字</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">Trace-Id</td>
<td>链路追踪id</td>
</tr>
<tr>
<td style="text-align: left;">Request-Datetime</td>
<td>请求时间</td>
</tr>
</tbody>
</table>