今天我們來聊如何利用快遞鳥提供的接口來查詢中通快遞的物流軌跡。
講解之前我們來看一下,接口完成以后的實際顯示效果
以下是我調用快遞鳥接口獲得的中通物流軌跡信息,顯示的界面效果需要自己開發:
現在我們來聊一聊具體實現!
首先我們准備好需要用到的資源,
測試商戶ID:
test1617571
測試API key:
554343b2-7252-439b-b4eb-1af42c8f2175(此Key僅限測試環境使用)
API測試地址:
http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
我以C#開發為例來講解,中通快遞查詢接口
如果還沒有注冊快遞鳥,或者還不知道如何獲取API Key,可以訪問這個騰訊視頻教程:
https://v.qq.com/x/page/z3068yfw0fl.html(注冊登陸獲取快遞鳥API Key)
接下來,我們講解一下請求參數
請求系統級參數說明:
備注:R-必填(Required),O-可選(Optional),C-報文中該參數在一定條件下可選(Conditional)
這里提到了系統級參數,也相當於是公用參數,這些參數是調用每個接口都是必須要傳參的。
接口參數:
接口參數,也叫業務參數,請求的業務接口不同,參數的字段,內容也不同,是跟着業務變化的,這里我們實現的是即時查詢接口,請求指令類型:1002,快遞鳥官網要求必須傳遞快遞公司編碼和物流單號 ,中通快遞的編碼是ZTO
如要查看其他快遞公司的編碼,點擊此鏈接:
http://www.kdniao.com/documents
正如我前面的軌跡截圖,是一個中通的軌跡數據,中通快遞的編碼是ZTO,物流單號是78120038107849
業務參數報文組合如下:
{'OrderCode':'','ShipperCode':'ZTO','LogisticCode':'78120038107849'}
請求的完整報文:
RequestData=%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27ZTO%27%2c%27LogisticCode%27%3a%2778120038107849%27%7d&EBusinessID=1617571&RequestType=1002&DataSign=YzBmYTViYmExZmFhOGY1ZTY3MWY5OGFjYWRhNWVjNjU%3d&DataType=2
返回的報文信息:
{ "LogisticCode" : "78120038107849", "ShipperCode" : "ZTO", "Traces" : [ { "AcceptStation" : "【濟源市】 【濟源】(0391-6965909) 的 張霞(18839032214) 已攬收", "AcceptTime" : "2020-01-16 18:30:33" }, { "AcceptStation" : "【濟源市】 快件離開 【濟源】 已發往 【深圳中心】", "AcceptTime" : "2020-01-16 18:36:41" }, { "AcceptStation" : "【新鄉市】 快件已經到達 【新鄉中轉】", "AcceptTime" : "2020-01-16 22:45:49" }, { "AcceptStation" : "【新鄉市】 快件離開 【新鄉中轉】 已發往 【深圳中心】", "AcceptTime" : "2020-01-16 22:47:48" }, { "AcceptStation" : "【深圳市】 快件已經到達 【深圳中心】", "AcceptTime" : "2020-01-18 04:05:46" }, { "AcceptStation" : "【深圳市】 快件離開 【深圳中心】 已發往 【深圳龍華】", "AcceptTime" : "2020-01-18 08:34:46" }, { "AcceptStation" : "【深圳市】 快件已經到達 【深圳龍華】", "AcceptTime" : "2020-01-18 13:14:10" }, { "AcceptStation" : "【深圳市】 【深圳龍華】 的陳智龍-王穎(13923773902) 正在第1次派件, 請保持電話暢通,並耐心等待(95720為中通快遞員外呼專屬號碼,請放心接聽)", "AcceptTime" : "2020-01-18 16:38:35" }, { "AcceptStation" : "【深圳市】 快件已由【豐巢的鑫茂花園A區(豐巢智能快遞櫃)】代簽收, 如有問題請電聯(13923773902 / 4000633333,18025858922), 感謝您使用中通快遞, 期待再次為您服務!", "AcceptTime" : "2020-01-18 17:32:15" } ], "State" : "3", "EBusinessID" : "1617571", "Success" : true }
C#關鍵代碼:
string requestData = "{'OrderCode':'','ShipperCode':'ZTO','LogisticCode':'78120038107849'}";
string dataSign = encrypt(requestData, “554343b2-7252-439b-b4eb-1af42c8f2175”, "UTF-8");
/// <summary>
/// 即時查詢物流軌跡
/// </summary>
/// <param name="url">http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json</param>
/// <param name="eBusinessID">test1617571</param>
/// <param name="appKey">554343b2-7252-439b-b4eb-1af42c8f2175</param>
/// <param name="requestData">{'OrderCode':'','ShipperCode':'ZTO','LogisticCode':'78120038107849'}</param>
/// <returns></returns>
public string getOrderTracesByJson(string url,string eBusinessID, string appKey, string requestData)
{
Dictionary<string, string> param = new Dictionary<string, string>();
param.Add("RequestData", HttpUtility.UrlEncode(requestData, Encoding.UTF8));
param.Add("EBusinessID", eBusinessID);
param.Add("RequestType", "1002");
string dataSign = encrypt(requestData, appKey, "UTF-8");
param.Add("DataSign", HttpUtility.UrlEncode(dataSign, Encoding.UTF8));
param.Add("DataType", "2");
string result = sendPost(url, param);
return result;
}
/// <summary>
/// Post方式提交數據,返回網頁的源代碼
/// </summary>
/// <param name="url">發送請求的 URL</param>
/// <param name="param">請求的參數集合</param>
/// <returns>遠程資源的響應結果</returns>
private string sendPost(string url, Dictionary<string, string> param)
{
string result = "";
StringBuilder postData = new StringBuilder();
if (param != null && param.Count > 0)
{
foreach (var p in param)
{
if (postData.Length > 0)
{
postData.Append("&");
}
postData.Append(p.Key);
postData.Append("=");
postData.Append(p.Value);
}
}
// return postData.ToString();
byte[] byteData = Encoding.GetEncoding("UTF-8").GetBytes(postData.ToString());
try
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
request.ContentType = "application/x-www-form-urlencoded";
request.Referer = url;
request.Accept = "*/*";
request.Timeout = 30 * 1000;
request.UserAgent = "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 2.0.50727; .NET CLR 3.0.04506.648; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729)";
request.Method = "POST";
request.ContentLength = byteData.Length;
Stream stream = request.GetRequestStream();
stream.Write(byteData, 0, byteData.Length);
stream.Flush();
stream.Close();
HttpWebResponse response = (HttpWebResponse)request.GetResponse();
Stream backStream = response.GetResponseStream();
StreamReader sr = new StreamReader(backStream, Encoding.GetEncoding("UTF-8"));
result = sr.ReadToEnd();
sr.Close();
backStream.Close();
response.Close();
request.Abort();
}
catch (Exception ex)
{
result = ex.Message;
}
return result;
}
///<summary>
///電商Sign簽名
///</summary>
///<param name="content">內容</param>
///<param name="keyValue">Appkey</param>
///<param name="charset">URL編碼 </param>
///<returns>DataSign簽名</returns>
private string encrypt(String content, String keyValue, String charset)
{
if (keyValue != null)
{
return base64(MD5(content + keyValue, charset), charset);
}
return base64(MD5(content, charset), charset);
}
///<summary>
/// 字符串MD5加密
///</summary>
///<param name="str">要加密的字符串</param>
///<param name="charset">編碼方式</param>
///<returns>密文</returns>
private string MD5(string str, string charset)
{
byte[] buffer = System.Text.Encoding.GetEncoding(charset).GetBytes(str);
try
{
System.Security.Cryptography.MD5CryptoServiceProvider check;
check = new System.Security.Cryptography.MD5CryptoServiceProvider();
byte[] somme = check.ComputeHash(buffer);
string ret = "";
foreach (byte a in somme)
{
if (a < 16)
ret += "0" + a.ToString("X");
else
ret += a.ToString("X");
}
return ret.ToLower();
}
catch
{
throw;
}
}
/// <summary>
/// base64編碼
/// </summary>
/// <param name="str">內容</param>
/// <param name="charset">編碼方式</param>
/// <returns></returns>
private string base64(String str, String charset)
{
return Convert.ToBase64String(System.Text.Encoding.GetEncoding(charset).GetBytes(str));
}
附上詳細的接口文檔給大家:
http://www.kdniao.com/documents
在項目要發布生產環境時,調用正式的API,快遞鳥會檢查我們是否有實名認證,如果沒有實名認證,是無法調用接口的。
騰訊視頻教程:https://v.qq.com/x/page/g3068jcoras.html(如何快速通過實名認證)
提供源碼下載:
https://download.csdn.net/download/yanghanwen/12139326
調用第三方物流接口,替換自己的key就能直接使用,主要實現了物流在線軌跡查詢,訂單訂閱,軌跡推送,支持500多家的快遞查詢接口,包括主流的四通一達,支持上門取件服務,其他接口調用,修改調用指令和參數就能實現。
演示截圖: