接入指南
<h3>一、 阅读对象</h3>
<p>此文档的阅读对象为对开放接口有一定了解的开发人员和运维人员，目的是帮助智数互动合作方开发接入相关能力。</p>
<h3>二、接口约定</h3>
<ul>
<li>网关：联系智数技术获取</li>
<li>统一使用post请求</li>
<li>指定Body Content-Type为：application/json;charset=UTF-8</li>
<li>
<p>所有参数均通过body json传递。</p>
</li>
<li>
<p>签名规则</p>
<p>为了防止API在调用过程中被恶意拦截随意篡改，调用API时需要传入签名参数，开放平台服务端会根据请求参数对签名进行验证，判断请求参数是否合法。<br />
签名算法：规则为MD5加密， md5(userName+“_”+date)<br />
举例:<img src="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=793e25610ac34b0d38ffa57778bba5cb&amp;file=file.png" alt="" /></p>
</li>
</ul>
<h3>三、结果解析</h3>
<ul>
<li>响应格式<br />
所有接口响应Content-Type均为：application/json，即响应均为json格式。接口响应有统一的格式：</li>
<li>成功格式
{
"success": true,
"code": 200,
"message": "请求成功",
"obj": [{
"createDate": "2024-10-29",
"createTime": "2024-10-31 11:02:22",
"mediumId": 7,
"advertId": 17,
"advertPlanId": 22,
"exposurePv": 4,
"exposureUv": 1,
"clickPv": 1,
"clickUv": 1,
"mediumName": "智数互动测试媒体",
"advertName": "智数互动测试广告位-1",
"advertPlanName": "悬浮全屏小程序",
"remark": "测试悬浮全屏小程序 开启口令接口获取"
}]
}
code为 200 表示请求成功，其他情况都为请求失败。<br />
接口请求成功时obj字段表示接口响应的业务数据。</li>
</ul>
<h3>四、 公共响应参数</h3>
<table>
<thead>
<tr>
<th>参数名</th>
<th>是否必选</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>是</td>
<td>int</td>
<td>响应代码</td>
</tr>
<tr>
<td>success</td>
<td>是</td>
<td>Boolean</td>
<td>是否成功</td>
</tr>
<tr>
<td>message</td>
<td>是</td>
<td>string</td>
<td>信息</td>
</tr>
<tr>
<td>obj</td>
<td>是</td>
<td>object</td>
<td>业务数据</td>
</tr>
</tbody>
</table>
<h3>五、平台返回状态码</h3>
<table>
<thead>
<tr>
<th>code</th>
<th>描述</th>
<th>解决</th>
</tr>
</thead>
<tbody>
<tr>
<td>200</td>
<td>请求成功</td>
<td>code为 200 表示请求成功，其他情况都为请求失败。</td>
</tr>
<tr>
<td>201</td>
<td>表示请求处理未成功</td>
<td>详细请看返回的message信息</td>
</tr>
<tr>
<td>502</td>
<td>签名验证失败</td>
<td>参考签名验证规则</td>
</tr>
</tbody>
</table>