![](https://img.laitimes.com/img/9ZDMuAjOiMmIsIjOiQnIsIyZuBnLwAjYycDMzUWNmZDOmVTZlZDN5kTNyQzNiNWNkRDOmhzN2MDZ2EmNi9CXt92Yu4GZjlGbh5SZslmZxl3Lc9CX6MHc0RHaiojIsJye.png)
快遞查詢API接口是使用的物流單号即可實作查詢物流資訊。主要應用在電商商城、ERP系統商、WMS系統商、快遞櫃、銀行等企業。多家快遞物流公司接口統一接入,建議對接接口提供商,一次性可以接入多家快遞,在後期的技術維護也會省下很多工作。
目前快遞查詢API接口有兩種實作方式,一種是主動查詢,一種是訂閱接口推送資料。以快遞鳥接口為例(接口對接需要接口秘鑰,這裡用的是測試的,不能夠正式使用,可以到快遞鳥官網申請www.kdniao.com/,是免費申請秘鑰的)最後附有一個的demo,更多demo可登陸快遞鳥網站查詢。
一.主動查詢(即時查詢API)
1)接口規則
a、查詢接口支援按照運單号查詢(單個查詢,并發不超過10個/S)。
b、指定的物流運單号選擇相應的快遞公司編碼,格式不對或則編碼錯誤都會返失敗的資訊。如圓通快遞物流單号應選擇圓通快遞公司編碼(YTO)
c、傳回的物流跟蹤資訊按照發生的時間升序排列。
d、接口指令1002。
e、請求位址:快遞鳥注冊2)系統級和應用級輸入參數系統級輸入參數
3)傳回結果參數
4)JSON請求示例
{
“OrderCode”: “”,
“ShipperCode”: “SF”,
“LogisticCode”: “118650888018”
}
// "YTO"為圓通快遞公司編碼,其他編碼可在快遞鳥官網下載下傳
5)JSON傳回示例
//沒有物流軌迹的
{
“EBusinessID”: “1109259”,
"Traces":[],
“OrderCode”: “”,
“ShipperCode”: “SF”,
“LogisticCode”: “118461988807”,
“Success”: true,
“Reason”: null
}
//有物流軌迹的
{
“EBusinessID”: “1109259”,
"OrderCode":"",
“ShipperCode”: “SF”,
“LogisticCode”: “118461988807”,
“Success”: true,
"CallBack":"",
“State”: 3,
“Reason”: null,
"Traces":[
{
"AcceptTime": "2014/06/25 08:05:37",
"AcceptStation": "正在派件..(派件人:鄧裕富,電話:18718866310)[深圳 市]",
"Remark": null
},
{
"AcceptTime": "2014/06/25 04:01:28",
"AcceptStation": "快件在 深圳集散中心 ,準備送往下一站 深圳 [深圳市]",
"Remark": null
},
{
"AcceptTime": "2014/06/2501:41:06",
"AcceptStation": "快件在 深圳集散中心 [深圳市]",
"Remark": null
},
{
"AcceptTime": "2014/06/24 20:18:58",
"AcceptStation": "已收件[深圳市]",
"Remark": null
},
{
"AcceptTime": "2014/06/24 20:55:28",
"AcceptStation": "快件在 深圳 ,準備送往下一站 深圳集散中心 [深圳市]",
"Remark": null
},
{
"AcceptTime": "2014/06/25 10:23:03",
"AcceptStation": "派件已簽收[深圳市]",
"Remark": null
},
{
"AcceptTime": "2014/06/25 10:23:03",
"AcceptStation": "簽收人是:已簽收[深圳市]",
"Remark": null
}
]
二.訂閱接口推送資料(物流跟蹤API)
訂閱查詢接口是定制化服務,使用者可将訂單資訊訂閱給快遞公司,快遞公司更新軌迹後,将實時轉換成标準接口形式,推送給使用者,起到實時推送的作用,提高效率。
同時使用者訂閱的資料還能選擇是否通知快遞員上門,實作線上下單功能。另外,快遞鳥還有在途監控、電子面單等其他的接口方案,可以根據公司需求來選擇。
a、訂單接收的資訊(分給了的網點,業務員的資訊),會通過推送接口推給客戶(訂閱并發不超過30次/S)客戶需要按要求實作接口。
b、僅支援Json格式。
c、請求指令1008。
d、測試接口位址:
e、聯調通過後請更換為正式位址:
f、分發及訂閱接口需要客戶方實作回調接口,回調RequestType(1008)
2)系統級和應用級參數
RequestData(必填參數,請求内容,JSON格式,須和DataType一緻))
使用者自定義回調資訊
WareHouseID
郵費支付方式:
1-現付,2-到付,3-月結,4-第三方支付
ExpType
String
O
快遞類型:1-标準快件
Cost
Double
O
寄件費(運費)
OtherCost
Double
O
其他費用
Receiver
Company
String
O
收件人公司
Name
String
O
收件人
Tel
String
O
電話
Mobile
String
O
手機
PostCode
String
O
收件人郵編
ProvinceName
String
O
收件省(如廣東省,不要缺少“省”)
CityName
String
O
收件市(如深圳市,不要缺少“市”)
ExpAreaName
String
O
收件區(如福田區,不要缺少“區”或“縣”)
Address
String
O
收件人詳細位址
Sender
Company
String
O
發件人公司
Name
String
O
發件人
Tel
String
O
發件人電話
Mobile
String
O
發件人手機
PostCode
String
O
發件人郵編
ProvinceName
String
O
發件省(如廣東省,不要缺少“省”)
CityName
String
O
發件市(如深圳市,不要缺少“市”)
ExpAreaName
String
O
發件區(如福田區,不要缺少“區”或“縣”)
Address
String
O
發件詳細位址
StartDate
String
O
上門取貨時間段:
"yyyy-MM-dd HH:mm:ss"格式化,本文中所有時間格式相同
EndDate
String
O
Weight
Double
O
物品總重量kg
Quantity
Int
O
件數/包裹數
Volume
Double
O
物品總體積m3
Remark
String
O
備注
IsNotice
Int
O
是否分發到快遞公司:1-不分發;0-分發.預設為0
IsSendMessage
Int
O
是否訂閱短信
0-不需要;1-需要
AddService
Name
String
0
增值服務名稱
Value
String
0
增值服務值
CustomerID
String
0
客戶辨別(選填)
Commodity
GoodsName
String
O
商品名稱
GoodsCode
String
O
商品編碼
Goodsquantity
Int
O
件數
GoodsPrice
Double
O
商品價格
GoodsWeight
Double
O
商品重量kg
GoodsDesc
String
O
商品描述
GoodsVol
Double
O
商品體積m3
EBusinessID
String
R
商戶ID
RequestType
String
R
請求指令類型:1008
DataSign
String
R
資料内容簽名
DataType
String
R
請求、傳回資料類型:2-json;
物流跟蹤APIdemo
import java.io.BufferedReader;import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;import java.io.UnsupportedEncodingException;
import java.net.HttpURLConnection;import java.net.URL;import java.net.URLEncoder;
import java.util.HashMap;import java.util.Map;import java.security.MessageDigest;
/*快遞鳥訂閱推送
2.0接口ID和Key請到官網申請:快遞單号查詢接口
//DEMO
public static void main(String[] args) {
KdniaoSubscribeAPI api = new KdniaoSubscribeAPI();
try {
String result = api.orderTracesSubByJson();
System.out.print(result);
} catch (Exception e) {
e.printStackTrace();
}
}
//電商ID
private String EBusinessID="請到快遞鳥官網申請http://www.kdniao.com/ServiceApply.aspx";
//電商加密私鑰,快遞鳥提供,注意保管,不要洩漏
private String AppKey="請到快遞鳥官網申請http://www.kdniao.com/ServiceApply.aspx";
//測試請求url
private String ReqURL = "http://testapi.kdniao.cc:8081/api/dist";
//正式請求url
//private String ReqURL = "http://api.kdniao.cc/api/dist";
/**
* Json方式 物流資訊訂閱
* @throws Exception
*/
public String orderTracesSubByJson() throws Exception{
String requestData="{'OrderCode': 'SF201608081055208281'," +
"'ShipperCode':'SF'," +
"'LogisticCode':'3100707578976'," +
"'PayType':1," +
"'ExpType':1," +
"'CustomerName':'',"+
"'CustomerPwd':''," +
"'MonthCode':''," +
"'IsNotice':0," +
"'Cost':1.0," +
"'OtherCost':1.0," +
"'Sender':" +
"{" +
"'Company':'LV','Name':'Taylor','Mobile':'15018442396','ProvinceName':'上海','CityName':'上海','ExpAreaName':'青浦區','Address':'明珠路73号'}," +
"'Receiver':" +
"{" +
"'Company':'GCCUI','Name':'Yann','Mobile':'15018442396','ProvinceName':'北京','CityName':'北京','ExpAreaName':'朝陽區','Address':'三裡屯街道雅秀大廈'}," +
"'Commodity':" +
"[{" +
"'GoodsName':'鞋子','Goodsquantity':1,'GoodsWeight':1.0}]," +
"'Weight':1.0," +
"'Quantity':1," +
"'Volume':0.0," +
"'Remark':'小心輕放'}";
Map<String, String> params = new HashMap<String, String>();
params.put("RequestData", urlEncoder(requestData, "UTF-8"));
params.put("EBusinessID", EBusinessID);
params.put("RequestType", "1008");
String dataSign=encrypt(requestData, AppKey, "UTF-8");
params.put("DataSign", urlEncoder(dataSign, "UTF-8"));
params.put("DataType", "2");
String result=sendPost(ReqURL, params);
//根據公司業務處理傳回的資訊......
return result;
}
/**
* MD5加密
* @param str 内容
* @param charset 編碼方式
* @throws Exception
*/
@SuppressWarnings("unused")
private String MD5(String str, String charset) throws Exception {
MessageDigest md = MessageDigest.getInstance("MD5");
md.update(str.getBytes(charset));
byte[] result = md.digest();
StringBuffer sb = new StringBuffer(32);
for (int i = 0; i < result.length; i++) {
int val = result[i] & 0xff;
if (val <= 0xf) {
sb.append("0");
}
sb.append(Integer.toHexString(val));
}
return sb.toString().toLowerCase();
}
/**
* base64編碼
* @param str 内容
* @param charset 編碼方式
* @throws UnsupportedEncodingException
*/
private String base64(String str, String charset) throws UnsupportedEncodingException{
String encoded = base64Encode(str.getBytes(charset));
return encoded;
}
@SuppressWarnings("unused")
private String urlEncoder(String str, String charset) throws UnsupportedEncodingException{
String result = URLEncoder.encode(str, charset);
return result;
}
/**
* 電商Sign簽名生成
* @param content 内容
* @param keyValue Appkey
* @param charset 編碼方式
* @throws UnsupportedEncodingException ,Exception
* @return DataSign簽名
*/
@SuppressWarnings("unused")
private String encrypt (String content, String keyValue, String charset) throws UnsupportedEncodingException, Exception
{
if (keyValue != null)
{
return base64(MD5(content + keyValue, charset), charset);
}
return base64(MD5(content, charset), charset);
}
/**
* 向指定 URL 發送POST方法的請求
* @param url 發送請求的 URL
* @param params 請求的參數集合
* @return 遠端資源的響應結果
*/
@SuppressWarnings("unused")
private String sendPost(String url, Map<String, String> params) {
OutputStreamWriter out = null;
BufferedReader in = null;
StringBuilder result = new StringBuilder();
try {
URL realUrl = new URL(url);
HttpURLConnection conn =(HttpURLConnection) realUrl.openConnection();
// 發送POST請求必須設定如下兩行
conn.setDoOutput(true);
conn.setDoInput(true);
// POST方法
conn.setRequestMethod("POST");
// 設定通用的請求屬性
conn.setRequestProperty("accept", "*/*");
conn.setRequestProperty("connection", "Keep-Alive");
conn.setRequestProperty("user-agent",
"Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1;SV1)");
conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
conn.connect();
// 擷取URLConnection對象對應的輸出流
out = new OutputStreamWriter(conn.getOutputStream(), "UTF-8");
// 發送請求參數
if (params != null) {
StringBuilder param = new StringBuilder();
for (Map.Entry<String, String> entry : params.entrySet()) {
if(param.length()>0){
param.append("&");
}
param.append(entry.getKey());
param.append("=");
param.append(entry.getValue());
System.out.println(entry.getKey()+":"+entry.getValue());
}
System.out.println("param:"+param.toString());
out.write(param.toString());
}
// flush輸出流的緩沖
out.flush();
// 定義BufferedReader輸入流來讀取URL的響應
in = new BufferedReader(
new InputStreamReader(conn.getInputStream(), "UTF-8"));
String line;
while ((line = in.readLine()) != null) {
result.append(line);
}
} catch (Exception e) {
e.printStackTrace();
}
//使用finally塊來關閉輸出流、輸入流
finally{
try{
if(out!=null){
out.close();
}
if(in!=null){
in.close();
}
}
catch(IOException ex){
ex.printStackTrace();
}
}
return result.toString();
}
private static char[] base64EncodeChars = new char[] {
'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H',
'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P',
'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X',
'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f',
'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n',
'o', 'p', 'q', 'r', 's', 't', 'u', 'v',
'w', 'x', 'y', 'z', '0', '1', '2', '3',
'4', '5', '6', '7', '8', '9', '+', '/' };
public static String base64Encode(byte[] data) {
StringBuffer sb = new StringBuffer();
int len = data.length;
int i = 0;
int b1, b2, b3;
while (i < len) {
b1 = data[i++] & 0xff;
if (i == len)
{
sb.append(base64EncodeChars[b1 >>> 2]);
sb.append(base64EncodeChars[(b1 & 0x3) << 4]);
sb.append("==");
break;
}
b2 = data[i++] & 0xff;
if (i == len)
{
sb.append(base64EncodeChars[b1 >>> 2]);
sb.append(base64EncodeChars[((b1 & 0x03) << 4) | ((b2 & 0xf0) >>> 4)]);
sb.append(base64EncodeChars[(b2 & 0x0f) << 2]);
sb.append("=");
break;
}
b3 = data[i++] & 0xff;
sb.append(base64EncodeChars[b1 >>> 2]);
sb.append(base64EncodeChars[((b1 & 0x03) << 4) | ((b2 & 0xf0) >>> 4)]);
sb.append(base64EncodeChars[((b2 & 0x0f) << 2) | ((b3 & 0xc0) >>> 6)]);
sb.append(base64EncodeChars[b3 & 0x3f]);
}
return sb.toString();
}