API 公共规约
<p>已取得通联产品入网资格的商户,向广分报备产品商户号,由通联向其发布商户服务API密钥。
其中进行商户服务API访问时参数由两部分组成,分别为公共参数、业务参数:</p>
<h5>【请求公共参数】</h5>
<table>
<thead>
<tr>
<th>参数名</th>
<th>说明</th>
<th>类型</th>
<th>长度</th>
<th>必填</th>
<th>备注</th>
</tr>
</thead>
<tbody>
<tr>
<td>version</td>
<td>接口版本</td>
<td>String</td>
<td>3</td>
<td>是</td>
<td>默认填1.0</td>
</tr>
<tr>
<td>charset</td>
<td>请求使用的编码格式</td>
<td>String</td>
<td>10</td>
<td>否</td>
<td>默认utf-8</td>
</tr>
<tr>
<td>orgId</td>
<td>集团唯一标识</td>
<td>string</td>
<td>64</td>
<td>否</td>
</tr>
<tr>
<td>appId</td>
<td>门店唯一标识</td>
<td>string</td>
<td>64</td>
<td>是</td>
</tr>
<tr>
<td>signType</td>
<td>商户生成签名字符串所使用的签名算法类型,目前支持MD5</td>
<td>String</td>
<td>10</td>
<td>否</td>
<td>默认MD5</td>
</tr>
<tr>
<td>sign</td>
<td>签名</td>
<td>String</td>
<td>128</td>
<td>是</td>
<td></td>
</tr>
<tr>
<td>timestamp</td>
<td>发送请求的时间,格式yyyyMMddHHmmss</td>
<td>String</td>
<td>14</td>
<td>是</td>
<td></td>
</tr>
<tr>
<td>bizContent</td>
<td>业务参数,JSON字符串</td>
<td>String</td>
<td></td>
<td>是</td>
<td>业务参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递</td>
</tr>
</tbody>
</table>
<h5>【请求业务参数】</h5>
<p>详见各API章节【请求业务参数】。</p>
<h5>【响应公共参数】</h5>
<table>
<thead>
<tr>
<th>参数名</th>
<th>说明</th>
<th>类型</th>
<th>长度</th>
<th>必填</th>
<th>备注</th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>请求返回码</td>
<td>String</td>
<td>6</td>
<td>是</td>
</tr>
<tr>
<td>msg</td>
<td>请求返回码描述</td>
<td>String</td>
<td>64</td>
<td>是</td>
<td></td>
</tr>
<tr>
<td>sign</td>
<td>签名</td>
<td>String</td>
<td>128</td>
<td>否</td>
<td>-</td>
</tr>
<tr>
<td>data</td>
<td>data</td>
<td>String</td>
<td>否</td>
<td>-</td>
</tr>
</tbody>
</table>
<h5>【响应业务参数】</h5>
<p>详见各API章节【响应业务参数】。</p>
<h5>【通知公共参数】</h5>
<table>
<thead>
<tr>
<th>参数名</th>
<th>说明</th>
<th>类型</th>
<th>长度</th>
<th>必填</th>
<th>备注</th>
</tr>
</thead>
<tbody>
<tr>
<td>timestamp</td>
<td>时间戳</td>
<td>String</td>
<td>无</td>
<td>否</td>
<td>格式:yyyy-MM-dd HH:mm:ss</td>
</tr>
<tr>
<td>sign</td>
<td>签名</td>
<td>String</td>
<td>128</td>
<td>否</td>
<td>-</td>
</tr>
<tr>
<td>data</td>
<td>数据</td>
<td>JsonString</td>
<td>无</td>
<td>否</td>
<td></td>
</tr>
</tbody>
</table>
<h5>【通知业务参数】</h5>
<p>详见各API章节【通知业务参数】。</p>
<h5>【请求方式】</h5>
<p>http/https post</p>
<h5>【数据格式】</h5>
<p>请求参数格式为:application/json
响应参数格式为:json</p>
<h5>【签名】</h5>
<p>需要参与签名的参数
allinpay节点下字段,除去sign字段外,其他字段皆需要参数签名。
生成待签名字符串
对于以下报文:</p>
<pre><code>appId=test
bizContent={&quot;customerUserId&quot;:&quot;ext-test&quot;,&quot;memberRole&quot;:&quot;00&quot;,&quot;memberType&quot;:3,&quot;sysId&quot;:&quot;1581648210684&quot;}
charset=utf-8
key=123456
signType=MD5
timestamp=20210723144012
version=1.0</code></pre>
<p>对于每个参与签名的字段及安全校验码(key)(假设key=123456),每个字段的名称需要小写并按字母顺序排序,最后添加上key。</p>
<pre><code>appid=test&amp;bizcontent={&quot;customerUserId&quot;:&quot;ext-test&quot;,&quot;memberRole&quot;:&quot;00&quot;,&quot;memberType&quot;:3,&quot;sysId&quot;:&quot;1581648210684&quot;}&amp;charset=utf-8&amp;service=logistics.member.register&amp;signtype=MD5&amp;timestamp=20210723144012&amp;version=1.0&amp;key=123456</code></pre>
<p>对待签名串进行MD5运算后将结果转化为大写,得出sign字段取值。</p>