【場景需求描述】
電商平臺及ISV商家對物流api接口的需求有很多,今天我們主要分享的就是快遞鳥快遞單號查詢接口的對接指南,快遞單號查詢接口對接的應用場景有很多,很多場景會遇到,最主要的就是電商網站用戶打開“我的訂單”時調用此API顯示物流信息詳情,電商管理後臺的物流系統,客服在對賬前查詢所有運單的簽收狀態,並追蹤問題,電商平臺對商家物流管控,要求必須在多久快遞必須發出要看到攬件狀態,多久必須收到貨物看到簽收狀態,根據這些狀態對商家管控從而提高用戶的整體滿意度。下圖是電商平臺、買家、商家的下單發貨流程圖。
【對接使用流程】
1、將快遞單號和快遞公司編碼發送給快遞鳥
2、快遞鳥根據單號和快遞公司查詢到物流軌跡狀態
3、快遞鳥將查詢到的物流軌跡狀態反饋給電商平臺或ISV服務商
4、電商平臺或ISV服務商接收數據並實時處理做數據展示或應用
【接口描述說明】
(1)查詢接口支持按照運單號查詢(單個查詢)。
(2)接口需要指定快遞單號的快遞公司編碼,格式不對或則編碼錯誤都會返失敗的信息。
如:EMS物流單號應選擇快遞公司編碼(EMS)查看快遞公司編碼
(3)返回的物流跟蹤信息按照發生的時間升序排列。
(4)接口指令1002。
(5)接口支持的消息接收方式爲HTTP POST,請求方法的編碼格式(utf-8):"application/x-www-form-urlencoded;charset=utf-8"。
(6)測試地址:http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
(7)正式地址:http://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx
請求系統級參數說明:
參數名稱 | 類型 | 說明 | 必須要求 |
---|---|---|---|
RequestData | String | 請求內容需進行URL(utf-8)編碼。請求內容JSON格式,須和DataType一致。 | R |
EBusinessID | String | 商戶ID,請在我的服務頁面查看。 | R |
RequestType | String | 請求指令類型:1002 | R |
DataSign | String | 數據內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然後Base64編碼,最後 進行URL(utf-8)編碼。詳細過程請查看Demo。 | R |
DataType | String | 請求、返回數據類型:2-json; | O |
備註:R-必填(Required),O-可選(Optional),C-報文中該參數在一定條件下可選(Conditional)
【接口參數】
請求內容字段定義:
參數名稱 | 類型 | 說明 | 必須要求 |
---|---|---|---|
OrderCode | String | 訂單編號 | O |
ShipperCode | String | 快遞公司編碼 | R |
LogisticCode | String | 物流單號 | R |
返回參數定義:
參數名稱 | 類型 | 說明 | 必須要求 |
---|---|---|---|
EBusinessID | String | 用戶ID | R |
OrderCode | String | 訂單編號 | O |
ShipperCode | String | 快遞公司編碼 | R |
LogisticCode | String | 物流運單號 | O |
Success | Bool | 成功與否 | R |
Reason | String | 失敗原因 | O |
State | String | 物流狀態:2-在途中,3-簽收,4-問題件 | R |
Traces | |||
AcceptTime | String | 時間 | R |
AcceptStation | String | 描述 | R |
Remark | String | 備註 | O |
【示例】
請求示例 JSON
{
"OrderCode": "",
"ShipperCode": "SF",
"LogisticCode": "118650888018"
}
返回示例 JSON
沒有物流軌跡的
{
"EBusinessID": "1109259",
"Traces": [],
"OrderCode": "",
"ShipperCode": "SF",
"LogisticCode": "118461988807",
"Success": false,
"Reason": null
}
有物流軌跡的
{
"EBusinessID": "1109259",
"OrderCode": "",
"ShipperCode": "SF",
"LogisticCode": "118461988807",
"Success": true,
"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/25 01: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
}
]
}
【JAVA快遞單號查詢接口Demo示例】,其他Demo去快遞鳥官網下載
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.security.MessageDigest;
import java.util.HashMap;
import java.util.Map;
/**
*
* 快遞鳥物流軌跡即時查詢接口
*
* @技術QQ羣: 456320272
* @see: http://www.kdniao.com/YundanChaxunAPI.aspx
* @copyright: 深圳市快金數據技術服務有限公司
*
* DEMO中的電商ID與私鑰僅限測試使用,正式環境請單獨註冊賬號
* 單日超過500單查詢量,建議接入我方物流軌跡訂閱推送接口
*
* ID和Key請到官網申請:http://www.kdniao.com/ServiceApply.aspx
*/
public class KdniaoTrackQueryAPI {
//DEMO
public static void main(String[] args) {
KdniaoTrackQueryAPI api = new KdniaoTrackQueryAPI();
try {
String result = api.getOrderTracesByJson("ANE", "210001633605");
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://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx";
/**
* Json方式 查詢訂單物流軌跡
* @throws Exception
*/
public String getOrderTracesByJson(String expCode, String expNo) throws Exception{
String requestData= "{'OrderCode':'','ShipperCode':'" + expCode + "','LogisticCode':'" + expNo + "'}";
Map<String, String> params = new HashMap<String, String>();
params.put("RequestData", urlEncoder(requestData, "UTF-8"));
params.put("EBusinessID", EBusinessID);
params.put("RequestType", "1002");
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();
}
}
【NET版本demo使用示例】
1、可以按照自己需求新建一個頁面,進行傳參和展示數據。
2、調用demo中的方法返回結果,對返回結果進行顯示處理。
3、將demo中如圖所示替換
4、對下圖方法中的入參進行處理,result即爲返回值。
5、下圖即爲按照上述方法處理後的效果圖。
【接入流程】
快遞鳥單號查詢接口(API)接入視頻教程
注:登錄快遞鳥用戶管理後臺後獲得用戶ID和APIKey對應各demo中的EBusinessID、AppKey。
小知識:EBusinessID跟APIKey是什麼?EBusinessID跟APIKey您在快遞鳥網站註冊之後快遞鳥分配的密鑰(對應官網上的用戶ID和API key),用於保證應用來源的可靠性,避免應用僞造,被不法使用。
3.進入“我的會員中心”進行實名認證
3.1、認證類型、應用類型根據用戶實際情況選擇即可,接口返回數據與選擇結果無關;
3.2、標記爲*的爲必填,要求上傳清晰、jpg格式且小於2M的證件圖片;
3.3、技術對接人信息爲用戶方對接工程師的信息;
3.4、如有其他疑問可進入快遞鳥官網加入右側的QQ羣進行諮詢。
4.認證成功後,進入“產品服務管理”,開通相關會員服務
4.1、物流查詢(免費版)會員套餐爲免費版,有效期1年結束後,如在近3個月內有數據交互系統會自動免費續期;
4.2、如有其他疑問可進入官網加入商務合作羣(羣號:616310430)進行諮詢。
5.開發對接
5.1、即時查詢(RequestType:1002/8001)日查詢次數<=3000次對接即時查詢接口
5.1.1、請求接口之前需要先實名認證,開通相關會員服務,否則會請求失敗並返回提示“未申請開通接口”;
5.1.2、接口開發可以下載“快遞鳥接口技術文檔”進行參考;即時查詢,參考技術文檔中的4.1或5.1.1部分;
5.1.3、接口開發可以下載“即時查詢demo”進行參考(僅提供了.NET、Java、PHP三種語言demo);
5.1.4、查看快遞公司對應快遞鳥的編碼可以下載“2018快遞鳥接口支持快遞公司編碼列表.xlsx”。
5.1.5、接入過程中如有疑問請先參考快遞鳥官網常見問題進行解決,也可以進入快遞鳥官網加入技術對接羣進行諮詢。
5.2、物流跟蹤(RequestType:1008/8008)日查詢次數>3000次對接物流跟蹤接口
5.2.1、請求接口之前需要先實名認證,開通相關會員服務,否則會請求失敗並返回提示“未申請開通接口”;
5.2.2、接口開發需下載“快遞鳥接口技術文檔”進行查看;物流跟蹤,參考技術文檔中的4.2或5.1.2部分;
5.2.3、開發訂閱接口:
5.2.3.1、可以下載“物流跟蹤demo”進行參考(僅提供了.NET、Java、PHP三種語言的demo),
其他語言開發的用戶需要根據技術文檔自行開發;
5.2.3.2、測試訂閱接口,對照技術文檔正確返回代表訂閱接口對接成功,詳情可見技術文檔。
5.2.4、開發推送接口:
5.2.4.1、無demo提供,推送時會推送requestType、requestData和DataSign三個參數,您開發一個推送接口接收這三個參數就行,成功接收後需要在5S內給快遞鳥返回成
功收數據的報文,否則超時。RequestData中包含應用級參數,即物流軌跡(詳情看技術文檔);
5.2.4.2、在沙箱調試平臺(沙箱調試平臺地址:http://kdniao.com/UserCenter/v2/SandBox/PushQueryParam.aspx)配置回調地址,測試推送接口。回調地址是用戶提供,
用於接收快遞鳥推送的物流信息的,只要是外網可以訪問的就行。測試、配置步驟如下:
a、填寫回調地址:
b、點擊【生成】後 應用級參數報文(RequestData)就是推送到用戶第一步時填寫的回調地址上的測試物流信息。
c、點擊【調用】,用戶接收到測試的物流信息後,用戶需要在 應用級參數報文區域 返回成功接收的信號給快遞鳥(注:字段間不要存在空格,空格會影響返回結果),
返回格式:{"EBusinessID":"1237100","UpdateTime":"2015-03-11 16:26:11","Success":true,"Reason": ""}
d、調用結果顯示爲請求成功後即用戶開發的推送接口通過測試。
e、測試通過後回到第一步填寫回調地址的位置點擊【配置】,彈出彈框,填寫手機號(必須是註冊快遞鳥賬號的手機號)、驗證碼、
回調地址,點擊【保存】配置成功即可在正式環境使用,下次如果需要修改回調地址同初次配置回調地址步驟一致。
5.2.5、訂閱接口、推送接口分別測試成功後,可使用正式地址進行訂閱真實的快遞單號,快遞鳥一般會在2-12小時內推送物流信息至您已經配置好的回調地址上;
5.2.6、接口開發查看快遞公司對應快遞鳥的編碼可以下載“2019快遞鳥接口支持快遞公司編碼列表.xlsx”;
5.2.7、接入過程中如有疑問請先參考快遞鳥官網常見問題進行解決,也可以進入快遞鳥官網加入技術對接羣進行諮詢。
【你可能還關心的問題】
1、問題:快遞鳥接口有併發要求嗎?
快遞鳥即時查詢接口併發不超過10次/秒,物流跟蹤接口訂閱不超過30次/秒,電子面單接口下單不超過20次/秒。
2、問題:快遞鳥api收費標準是什麼?
快遞鳥查詢接口和電子面單等接口都是免費提供的,如果您對數據的狀態時效、服務等有特別的需求,可聯繫快遞鳥工作人員,爲您量身定製專屬解決方案,具體收費會根據您的需求進行商定。
3、問題:快遞鳥數據更新實時性如何?
即時查詢接口:實時獲取當前最新軌跡信息,數據與官網信息一致。
物流跟蹤接口:快遞鳥每2小時到快遞公司獲取軌跡,如果您訂閱的單號沒有軌跡更新,間隔2小時後再次到快遞公司獲取軌跡,依次循環直到有物流軌跡更新,獲取到新軌跡後進行排隊序列推送。
4、問題:快遞鳥數據準確性,會不會存在物流狀態不準確的問題?
軌跡信息準確度大於99.9%。物流軌跡信息保持與快遞公司官網一致,偶爾存在快遞公司提供的接口數據與官網不一致的情況,不一致情況小於0.1%。
5、問題:快遞鳥即時查詢接口和物流跟蹤接口有什麼區別?
(1)接入方式不一樣:
即時查詢接口,根據快遞單號和快遞公司編碼實時查詢物流軌跡信息。
物流跟蹤接口,用戶訂閱快遞號,快遞鳥系統會定時推送新的物流信息。
(2)實現的功能不一樣:
即時查詢接口,單次請求只能查詢一個單的物流信息,支持10次/S的併發請求。
物流跟蹤接口,訂閱推送的模式獲取軌跡信息,發起一次訂閱後,快遞鳥會持續監控推送更新的軌跡信息,直到簽收。
(3)查詢單量不一樣:
即時查詢每日查詢次數<=3000次,物流跟蹤不限制訂閱單量,並可一直獲得每個單號的更新信息。
6、問題: 快遞鳥物流跟蹤數據的時效性怎樣?
在接收到新的快遞單後,會立即加入監控隊列,有結果的話會即時內返回,沒有結果的話,會等待一定時間(如2小時)再進行下一次監控。對於這些後續的監控,如果某運單號在快遞公司官網對應的結果B,B最新一條狀態所對應的時間爲T1,快遞鳥將B推送給貴公司的時間爲T2,那麼|T2-T1|一般在0~2~4 個小時以內,但我方會不斷地向貴方進行推送,使運單狀態能持續地更新。
7、問題:快遞鳥物流跟蹤是需要我們自己開發接收接口是嗎?
對接物流跟蹤接口,你需要開發訂閱接口(將單號和快遞公司編碼訂閱給快遞鳥。有訂閱接口的.net,php和java版本demo,你可以參考下。還有自己開發一個推送接口(接收快遞鳥推送的物流軌跡),開發完後登錄快遞鳥沙箱後臺調試推送接口,調試成功後可在沙箱後臺自助配置推送接口。
8、問題:快遞鳥物流跟蹤的推送接口怎麼做?
推送接口是用於接收推送的物流信息,推送接口是我們調用你的接口,你只需要接收參數,在沙箱後臺配置你的回調地址就行,RequestData中包含應用級參數,即物流軌跡,推送時會推送requestType、requestData和DataSign三個參數(詳情看技術文檔),您開發一個推送接口接收這三個參數就行。
9、問題:快遞鳥的物流跟蹤API實現原理是什麼?
訂閱接口的工作原理是:用戶將快遞單號訂閱給我們,我們即刻加入隊列去物流公司官方接口查詢,查詢有軌跡就給用戶推送。如果沒有更新數據,兩個小時後會再次去物流公司官方接口查詢,有新數據就將全量數據推送給用戶,如果沒有更新數據,兩個小時後再重複上述動作,直到運單簽收。
10、問題:快遞鳥支持哪些快遞物流公司查詢接口?
快遞鳥支持418家快遞物流公司的接口,具體在快遞鳥官網下載《2019快遞鳥接口支持快遞公司編碼.xlsx》查看。