快递签单回传
<h3>接口描述</h3>
<ul>
<li>仅支持在运单揽收后订阅，未揽收的单订阅会推送失败（部分单需要揽收后到达下一城市才可订阅，故尽量在揽收后一节点产生时再订阅）</li>
<li>用户将订单信息向聚美智数订阅，聚美智数向快递公司下发请求，当产生签单时，快递公司推送至聚美智数，聚美智数再同步推送至用户</li>
</ul>
<h3>订阅说明</h3>
<h4>请求地址</h4>
<p><code>https://api.jumdata.com/express/sign-image/subscribe</code></p>
<h4>请求方式</h4>
<ul>
<li>POST</li>
</ul>
<h4>请求格式</h4>
<ul>
<li>x-www-form-urlencoded</li>
</ul>
<h4>请求参数</h4>
<table>
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>必须</th>
<th><div style="width:400px">说明</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>shipperCode</td>
<td>String</td>
<td>是</td>
<td>快递公司编号。顺丰速运：SF、中通快运：ZTOKY、京东快递：JD、京东快运：JDKY、跨越速运：KYSY、德邦快递：DBL、德邦快运：DBLKY、百世快运：BTWL、百腾物流：BETWL、顺心捷达：SX</td>
</tr>
<tr>
<td>logisticCode</td>
<td>String</td>
<td>是</td>
<td>运单编号(需要是签回单的单号)</td>
</tr>
<tr>
<td>callBackUrl</td>
<td>String</td>
<td>是</td>
<td>签单信息推送地址，以https/http协议开头，长度不能大于200</td>
</tr>
<tr>
<td>imgType</td>
<td>String</td>
<td>是</td>
<td>图片类型，详见：<a href="#图片类型">详见图片类型表</a></td>
</tr>
<tr>
<td>mobile</td>
<td>String</td>
<td>否</td>
<td>收/寄件电话号码。顺丰可选，德邦必填</td>
</tr>
<tr>
<td>clientCode</td>
<td>String</td>
<td>否</td>
<td>顾客编码，中通快运、百腾物流可以不填，其他必填。<br/>顺丰：[顺丰顾客编码获取方法](<a href="https://file.jumdata.com/support/express/SF-customer-code-get.docx">https://file.jumdata.com/support/express/SF-customer-code-get.docx</a> "顺丰顾客编码获取方法")。跨越速运：联系所属跨越速运经理获取客户编码并提供给聚美智数技术支持进行注册。</td>
</tr>
<tr>
<td>monthCode</td>
<td>String</td>
<td>否</td>
<td>月结卡号，德邦必填，顺丰可选：后台可配置检验月结卡号or电话号码（默认校验月结卡号），若校验月结卡号则必填。</td>
</tr>
</tbody>
</table>
<h4>签名算法说明</h4>
<p><code>sign = sha256(appId + appSecret + timestamp)</code></p>
<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>
<h4>成功返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 200, // 详见code返回码说明
&quot;msg&quot;: &quot;成功&quot;, // code 对应的描述
&quot;charge&quot;: true, // 计费标志
&quot;taskNo&quot;: &quot;30853523396532856721&quot;, // 本次请求号
}</code></pre>
<h4>失败返回样例</h4>
<pre><code class="language-json">{
&quot;code&quot;: 400,
&quot;msg&quot;: &quot;运单编号不能为空&quot;
}</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>charge</td>
<td>计费标志</td>
</tr>
<tr>
<td>taskNo</td>
<td>本次请求号</td>
</tr>
<tr>
<td>data</td>
<td>返回具体结果，object类型，详见data返回字段描述</td>
</tr>
</tbody>
</table>
<h4>code返回码说明</h4>
<table>
<thead>
<tr>
<th>code</th>
<th><div style="width:400px">说明</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>200</td>
<td>成功（计费）</td>
</tr>
<tr>
<td>201</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>607</td>
<td>ip不在白名单</td>
</tr>
<tr>
<td>609</td>
<td>请求过于频繁，请稍候再试</td>
</tr>
<tr>
<td>610</td>
<td>请求超时</td>
</tr>
<tr>
<td>999</td>
<td>其他，以实际返回为准</td>
</tr>
</tbody>
</table>
<h3>推送说明</h3>
<ul>
<li>当产生签单时，聚美智数将信息推送至接入商提供地址为<strong>callBackUrl</strong>的接口</li>
</ul>
<h4>数据结构</h4>
<pre><code class="language-json">{
&quot;code&quot;: &quot;200&quot;,
&quot;imageList&quot;: [
&quot;https://xxxxx.png&quot;
],
&quot;logisticCode&quot;: &quot;JDVC32388123456&quot;,
&quot;shipperCode&quot;: &quot;JD&quot;
}
</code></pre>
<h4>请求格式</h4>
<ul>
<li>application/json</li>
</ul>
<h4>签名验证</h4>
<p>为了防止推动过程中数据被篡改，聚美智数将推送数据进行签名，将签名和数据一并推送，具体步骤如下：</p>
<p>1、在推送数据前拼接appSecret,对拼接后的数据做SHA256哈希，得到sign</p>
<pre><code class="language-java">sign = sha256(appSecret + 推送数据)</code></pre>
<p>例如：
appSecret：312aadadas3123ddadas
推送数据: { "shipperCode":"JD", "logisticCode":"JDVC32388123456" "code":"200", "imageList":[...]}
则拼接后数据为：312aadadas3123ddadas {"shipperCode":"JD", "logisticCode":"JDVC32388123456" "code":"200", "imageList":[...]}
再将拼接后的数据进行SHA256哈希，得到sign：trtret31212aa2312312dadas3123ddadas</p>
<p>2、sign放置在请求header中推送至接入商，headr name=sign
3、接入商接收到推送数据后，根据步骤1生成sign，与header中的sign进行比较是否一致，一致说明数据没有被篡改</p>
<h4>返回接收结果</h4>
<ul>
<li>接入商需要返回接收处理结果返回给聚美智数</li>
<li>如果是接收失败，聚美智能会再次推送，最多推送3次</li>
</ul>
<pre><code class="language-json">//接收成功
{
&quot;success&quot;:true
}
// 接收失败
{
&quot;success&quot;:false,
&quot;msg&quot;: &quot;接收失败&quot;
} </code></pre>
<h4>接收示例(java)</h4>
<pre><code class="language-java">@PostMapping(&quot;callbackUrl&quot;)
public Map&lt;String,Object&gt; receive(@RequestBody String data, HttpServletRequest request) {
log.info(&quot;接收到快递签单回传数据: {}&quot;, data);
String signInHeader = request.getHeader(&quot;sign&quot;);
String signText = appSecret + data;
String sign = DigestUtils.sha256Hex(signText);
log.info(&quot;sign: {}&quot;, sign);
log.info(&quot;signInHeader: {}&quot;, signInHeader);
Map&lt;String,Object&gt; map = new HashMap&lt;&gt;();
if (StringUtils.equals(sign, signInHeader)) {
... // 处理自己的业务逻辑
if (处理成功) {
map.put(&quot;success&quot;,true);
} else {
map.put(&quot;success&quot;,false);
map.put(&quot;msg&quot;,&quot;接收失败, xxx&quot;);
}
} else {
map.put(&quot;success&quot;,false);
map.put(&quot;msg&quot;,&quot;接收失败，签名不正确&quot;);
}
return map;
}</code></pre>
<p><a name="图片类型"/></p>
<h4>图片类型</h4>
<table>
<thead>
<tr>
<th>序号</th>
<th>代码</th>
<th><div style="width:400px">图片类型</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>P101</td>
<td>拍照回传</td>
</tr>
<tr>
<td>2</td>
<td>P102</td>
<td>电子签收</td>
</tr>
<tr>
<td>3</td>
<td>P103</td>
<td>回单图片</td>
</tr>
<tr>
<td>4</td>
<td>P104</td>
<td>第三方</td>
</tr>
<tr>
<td>5</td>
<td>P105</td>
<td>代收货款</td>
</tr>
<tr>
<td>6</td>
<td>P106</td>
<td>清单</td>
</tr>
<tr>
<td>7</td>
<td>P107</td>
<td>发票</td>
</tr>
<tr>
<td>8</td>
<td>P108</td>
<td>装箱单</td>
</tr>
<tr>
<td>9</td>
<td>P109</td>
<td>代理报关委托书</td>
</tr>
<tr>
<td>10</td>
<td>P110</td>
<td>合同</td>
</tr>
<tr>
<td>11</td>
<td>P111</td>
<td>报关单</td>
</tr>
<tr>
<td>12</td>
<td>P112</td>
<td>核消单</td>
</tr>
<tr>
<td>13</td>
<td>P113</td>
<td>许可证</td>
</tr>
<tr>
<td>14</td>
<td>P114</td>
<td>同城件拍照</td>
</tr>
<tr>
<td>15</td>
<td>P115</td>
<td>开箱验证图片</td>
</tr>
<tr>
<td>16</td>
<td>P116</td>
<td>派送证明</td>
</tr>
<tr>
<td>17</td>
<td>P117</td>
<td>托寄物照片</td>
</tr>
<tr>
<td>18</td>
<td>P118</td>
<td>医药图片</td>
</tr>
<tr>
<td>19</td>
<td>P119</td>
<td>开箱拍照</td>
</tr>
<tr>
<td>20</td>
<td>P120</td>
<td>nike笼车方案pod单照片</td>
</tr>
<tr>
<td>21</td>
<td>P121</td>
<td>复重图片</td>
</tr>
<tr>
<td>22</td>
<td>P122</td>
<td>派件特安件妥投、标记异常</td>
</tr>
<tr>
<td>23</td>
<td>P123</td>
<td>签单返回范本图片</td>
</tr>
<tr>
<td>24</td>
<td>P124</td>
<td>中转复重图片</td>
</tr>
<tr>
<td>25</td>
<td>P125</td>
<td>重货-大件入户派件端增加拍照</td>
</tr>
<tr>
<td>26</td>
<td>P126</td>
<td>入仓增值服务图片</td>
</tr>
<tr>
<td>27</td>
<td>P127</td>
<td>其他</td>
</tr>
</tbody>
</table>