港澳通行证OCR(停用)
<h3>接口描述</h3>
<ul>
<li>支持对大陆居民往来港澳通行证的证件号码、姓名、姓名拼音、出生日期、性别、有效期限、签发地点等</li>
<li>图片大小必须在20K到500K之间,支持jpg/png/bmp格式。</li>
</ul>
<h3>请求地址</h3>
<p><code>https://api.jumdata.com/ocr/hgMacaoPass</code></p>
<h3>请求方式</h3>
<ul>
<li>POST</li>
</ul>
<h3>请求格式</h3>
<ul>
<li>form-data</li>
</ul>
<h3>请求参数</h3>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>appId</td>
<td>String</td>
<td>是</td>
<td>服务商分配的唯一标识</td>
</tr>
<tr>
<td>timestamp</td>
<td>Long</td>
<td>是</td>
<td>当前时间的毫秒数</td>
</tr>
<tr>
<td>sign</td>
<td>String</td>
<td>是</td>
<td>签名,见签名算法说明</td>
</tr>
<tr>
<td>base64</td>
<td>String</td>
<td>否</td>
<td>图片base64。base64、url、file 三选其一</td>
</tr>
<tr>
<td>url</td>
<td>String</td>
<td>否</td>
<td>图片完整url。base64、url、file 三选其一</td>
</tr>
<tr>
<td>file</td>
<td>String</td>
<td>否</td>
<td>图片文件。base64、url、file 三选其一</td>
</tr>
</tbody>
</table>
<ul>
<li><strong>base64,url,file必须提供一个,优先级:base64 > file > url</strong></li>
</ul>
<h3>签名算法说明</h3>
<pre><code>sign = sha256( appId + appSecret + timestamp)</code></pre>
<p>用服务商分配的 appId、服务商分配的 appSecret,当前时间毫秒数 timestamp,按上述顺序拼接成字符串,再进行 sha256 哈希得到。如下:</p>
<pre><code class="language-java">String appId = &quot;xyzxy2121zxyz&quot;;
String timestamp = &quot;1555378976238&quot;;
String appSecret = &quot;efcefcef1121cefcefc1212121&quot;;
String str = appId + appSecret + timestamp;
String sign = sha256(str);</code></pre>
<h3>正确返回样例</h3>
<pre><code class="language-json">{
&quot;code&quot;: 200, // 返回码,详见返回码说明
&quot;msg&quot;: &quot;成功&quot;, // 返回码对应描述
&quot;taskNo&quot;: &quot;65605503936940344488&quot;, // 本次请求号
&quot;charge&quot;: false, // 计费标志
&quot;data&quot;: {
&quot;ValidDate&quot;: &quot;2021202012&quot;,//有效期限
&quot;Address&quot;: &quot;&quot;,//签发地点
&quot;NameChn&quot;: &quot;程东&quot;,//姓名
&quot;Sex&quot;: &quot;男&quot;,//性别
&quot;NameEng&quot;: &quot;CHENGDONG&quot;,//姓名拼音
&quot;Birthday&quot;: &quot;19880808&quot;,//出生日期
&quot;CardNum&quot;: &quot;LCC183935&quot;//证件号码
}
}</code></pre>
<h3>错误返回样例</h3>
<pre><code class="language-json">{
&quot;msg&quot;: &quot;未检测到港澳通行证图片&quot;,
&quot;code&quot;: 702
}</code></pre>
<h3>返回字段说明</h3>
<table>
<thead>
<tr>
<th>字段名</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>返回码,详见:code返回码说明</td>
</tr>
<tr>
<td>msg</td>
<td>code对应的描述</td>
</tr>
<tr>
<td>taskNo</td>
<td>本次请求号</td>
</tr>
<tr>
<td>charge</td>
<td>计费标志</td>
</tr>
<tr>
<td>data</td>
<td>返回具体结果,object类型,详见成功返回体</td>
</tr>
</tbody>
</table>
<h4>code返回码说明</h4>
<table>
<thead>
<tr>
<th>code</th>
<th><div style="width:420px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>200</td>
<td>成功(计费)</td>
</tr>
<tr>
<td>400</td>
<td>参数错误</td>
</tr>
<tr>
<td>404</td>
<td>接口地址不正确</td>
</tr>
<tr>
<td>500</td>
<td>系统维护,请稍候再试</td>
</tr>
<tr>
<td>601</td>
<td>接口未开通</td>
</tr>
<tr>
<td>602</td>
<td>账号停用</td>
</tr>
<tr>
<td>603</td>
<td>余额不足请充值</td>
</tr>
<tr>
<td>604</td>
<td>接口停用</td>
</tr>
<tr>
<td>606</td>
<td>调用超限,请稍候再试</td>
</tr>
<tr>
<td>609</td>
<td>请求过于频繁,请稍候再试</td>
</tr>
<tr>
<td>702</td>
<td>未检测到港澳通行证图片</td>
</tr>
<tr>
<td>999</td>
<td>其他,以实际返回为准</td>
</tr>
</tbody>
</table>