快递物流轨迹订阅_国际
<h3>接口描述</h3>
<ul>
<li>先调用订阅接口订阅快递物流轨迹</li>
<li>订阅成功后，当物流轨迹发生变动时，由聚美智数调用接入商户提供的api推送至接入商</li>
</ul>
<h3>订阅说明</h3>
<h4>请求地址</h4>
<p><code>https://api.jumdata.com/express/international-logistics/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>expressCode</td>
<td>String</td>
<td>是</td>
<td>快递公司编号，详见：<a href="#快递公司编码对照表">快递公司编码对照表</a></td>
</tr>
<tr>
<td>number</td>
<td>String</td>
<td>是</td>
<td>运单编号</td>
</tr>
<tr>
<td>callBackUrl</td>
<td>String</td>
<td>是</td>
<td>物流轨迹推送地址，以https/http协议开头，长度不能大于200</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;30853523396532582768&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>400</td>
<td>参数错误</td>
</tr>
<tr>
<td>404</td>
<td>请求地址不正确</td>
</tr>
<tr>
<td>411</td>
<td>快递公司代码不存在</td>
</tr>
<tr>
<td>412</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;expressCode&quot;: &quot;00173&quot;, // 物流公司代码
&quot;number&quot;: &quot;1ZA596X70455692862&quot;, // 单号
&quot;sendCountry&quot;: &quot;GUANGZHOU, 510410, CN, China&quot;, // 发送国
&quot;sendLogisticsCompany&quot;: &quot;00173&quot;, // 发件地快递公司
&quot;purposeCountry&quot;: &quot;BRONX, NY, 10462, US, United States&quot;, // 目的国
&quot;purposeLogisticsCompany&quot;: &quot;00172&quot;, // 目的地快递公司
&quot;logisticsStatus&quot;: &quot;SIGN&quot;, // 物流最新状态
&quot;acceptTime&quot;: 1649241360000, //上网时间
&quot;signTime&quot;: 1649708160000, // 签收时间
&quot;theTraceDetails&quot;: { // 最新一条事件状态
&quot;areaAddress&quot;: &quot;BRONX, NY, 10462, US, United States&quot;, // 事件发生地
&quot;desc&quot;: &quot;BRONX, NY, 10462, US, United States, Delivered&quot;, // 事件描述
&quot;logisticsStatus&quot;: &quot;SIGN&quot;, //事件状态
&quot;subLogisticsStatus&quot;: &quot;SIGN&quot;, // 子事件状态
&quot;time&quot;: 1649708160000 // 事件发生时间
},
&quot;sendTraceDetails&quot;: [ // 发件国事件状态
{
&quot;areaAddress&quot;: &quot;BRONX, NY, 10462, US, United States&quot;, // 事件发生地
&quot;desc&quot;: &quot;BRONX, NY, 10462, US, United States, Delivered&quot;, // 事件描述
&quot;logisticsStatus&quot;: &quot;SIGN&quot;, //事件状态
&quot;subLogisticsStatus&quot;: &quot;SIGN&quot;, // 子事件状态
&quot;time&quot;: 1649708160000 // 事件发生时间
},
{
&quot;areaAddress&quot;: &quot;MOUNT VERNON, NY, 10550, US, United States&quot;,
&quot;desc&quot;: &quot;MOUNT VERNON, NY, 10550, US, United States, On FedEx vehicle for delivery&quot;,
&quot;logisticsStatus&quot;: &quot;DELIVERING&quot;,
&quot;subLogisticsStatus&quot;: &quot;DELIVERING&quot;,
&quot;time&quot;: 1649679240000
}
...
],
&quot;purposeTraceDetails&quot;: [ // 目的国事件状态
{
&quot;areaAddress&quot;: &quot;MOUNT VERNON, NY, 10550, US, United States&quot;,
&quot;desc&quot;: &quot;MOUNT VERNON, NY, 10550, US, United States, At local FedEx facility&quot;,
&quot;logisticsStatus&quot;: &quot;TRANSPORT&quot;,
&quot;subLogisticsStatus&quot;: &quot;TRANSPORT&quot;,
&quot;time&quot;: 1649670060000
},
{
&quot;areaAddress&quot;: &quot;JAMAICA, NY, 11430, US, United States&quot;,
&quot;desc&quot;: &quot;JAMAICA, NY, 11430, US, United States, At destination sort facility&quot;,
&quot;logisticsStatus&quot;: &quot;TRANSPORT&quot;,
&quot;subLogisticsStatus&quot;: &quot;TRANSPORT&quot;,
&quot;time&quot;: 1649501640000
},
...
],
}
</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
推送数据: { "expressCode":"EMS", "number":"9796578035309" "logisticsStatus":"SIGN", "logisticsStatusDesc":"已签收" "details":[...}
则拼接后数据为：312aadadas3123ddadas { "expressCode":"EMS", "number":"9796578035309" "logisticsStatus":"SIGN", "logisticsStatusDesc":"已签收" "details":[...}
再将拼接后的数据进行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>
<h3>业务对照表</h3>
<p><a name="快递公司编号对照表"/></p>
<h4>快递公司编码对照表</h4>
<p>[下载快递公司编号对照表](<a href="https://file.jumdata.com/support/express/inter-express-code.xlsx">https://file.jumdata.com/support/express/inter-express-code.xlsx</a> "下载快递公司编号对照表")</p>
<h4>物流状态对照表</h4>
<p><a name="物流状态对照表"/></p>
<table>
<thead>
<tr>
<th>序号</th>
<th><div style="width:300px">物流主状态</div></th>
<th><div style="width:350px">物流子状态</div></th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>WAIT_ACCEPT: 待揽收</td>
<td>RECEIVE: 接单中 <br />WAIT_ACCEPT: 待揽收</td>
</tr>
<tr>
<td>2</td>
<td>ACCEPT: 已揽收</td>
<td>ACCEPT: 已揽收</td>
</tr>
<tr>
<td>3</td>
<td>TRANSPORT: 运输中</td>
<td>TRANSPORT: 运输中<br/>ON_THE_WAY: 在途中<br/>SEND_ON: 转单或修改地址转寄<br/>ARRIVE_CITY: 到达目的城市</td>
</tr>
<tr>
<td>4</td>
<td>DELIVERING: 派件中</td>
<td>DELIVERING: 派件中<br/>STA_INBOUND: 已放入快递柜或驿站</td>
</tr>
<tr>
<td>5</td>
<td>AGENT_SIGN: 已代签收</td>
<td>AGENT_SIGN: 已代签收</td>
</tr>
<tr>
<td>6</td>
<td>SIGN:已签收</td>
<td>SIGN: 已签收<br/>STA_SIGN: 从快递柜或者驿站取出<br/>RETURN_SIGN：退回签收</td>
</tr>
<tr>
<td>7</td>
<td>FAILED:包裹异常</td>
<td>FAILED: 包裹异常<br/>TIMEOUT_UNSIGEN: 超时未签收<br/>TIMEOUT_NO_UPDATE: 超时未更新<br/>REFUSE_SIGN: 拒收<br/>DELIVER_ABNORMAL: 派件异常<br/>STA_TIMEOUT_UNSIGEN: 快递柜或者驿站超时未取<br/>CONTACT_FAIL: 无法联系<br/>OVER_AREA: 超区<br/>RETENTION: 滞留件<br/>ISSUE: 问题件<br/>RETURN: 退回件<br/>SEND_NO_MESSAGE: 发货无信息<br/>DAMAGE: 破损</td>
</tr>
</tbody>
</table>
<p>[下载物流状态对应表](<a href="https://file.jumdata.com/support/express/express-logistics-status.xlsx">https://file.jumdata.com/support/express/express-logistics-status.xlsx</a> "下载物流状态对应表")</p>