5.1获取通行证
<p>[TOC]</p>
<h5>简要描述</h5>
<ul>
<li>获取通行证接口</li>
<li>接口方向:接入方 → 本平台</li>
<li>适用于获取通行证号码scmPassNumber值</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>http://xx.com/scm/authentication</code></li>
</ul>
<h5>请求方式</h5>
<ul>
<li>POST("Content-Type" ,"application/json")</li>
</ul>
<h5>参数</h5>
<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;">apiClientId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>商户id</td>
</tr>
<tr>
<td style="text-align: left;">encryptedData</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>加密数据(规则请看加密章节2.2)</td>
</tr>
<tr>
<td style="text-align: left;">sign</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>sha256签名(规则请看签名章节2.3)</td>
</tr>
</tbody>
</table>
<h5>返回示例</h5>
<pre><code> {
&quot;success&quot;: true,
&quot;code&quot;: &quot;00000&quot;,
&quot;message&quot;: &quot;请求成功&quot;,
&quot;data&quot;: {
&quot;apiClientId&quot;: &quot;1770702734893621250&quot;,
&quot;scmPassNumber&quot;: &quot;bfadab2c-8fc8-4ccc-81a4-38347e785a7f&quot;,
&quot;passCreateTime&quot;: &quot;2024-05-14 15:57:20.683&quot;,
&quot;passExpirationTime&quot;: &quot;2024-05-17 15:57:20.683&quot;
}
}</code></pre>
<h5>返回参数说明</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">code</td>
<td style="text-align: left;">string</td>
<td>请求结果,请看结果码章节</td>
</tr>
<tr>
<td style="text-align: left;">success</td>
<td style="text-align: left;">string</td>
<td>true请求成功,false请求失败</td>
</tr>
<tr>
<td style="text-align: left;">message</td>
<td style="text-align: left;">string</td>
<td>返回结果描述</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">string</td>
<td>产品配置Json数组,无配置时返回空数组[]</td>
</tr>
<tr>
<td style="text-align: left;">- apiClientId</td>
<td style="text-align: left;">string</td>
<td>商户ID</td>
</tr>
<tr>
<td style="text-align: left;">- scmPassNumber</td>
<td style="text-align: left;">string</td>
<td>通行证号码</td>
</tr>
<tr>
<td style="text-align: left;">- passCreateTime</td>
<td style="text-align: left;">string</td>
<td>创建时间</td>
</tr>
<tr>
<td style="text-align: left;">- passExpirationTime</td>
<td style="text-align: left;">string</td>
<td>截止时间</td>
</tr>
</tbody>
</table>
<h5>备注</h5>
<ul>
<li>更多返回错误代码请看首页的错误代码描述</li>
</ul>