快遞單號識別API 快遞鳥介面
單號識別API介面,主要也是為了提供使用者使用體驗,減少客戶操作步驟,以及人工查錯,客戶提供快遞單號,即可實時返回可能的一個或多個快遞公司,存在多個快遞公司結果的,大資料平臺根據可能性、單號量,進行智慧排序。我們在PC端、移動端應用或網站應用整合運單物流資訊查詢功能時,只需要錄入單號即可完成查詢,無需使用者輸入快遞公司。這個介面解決了我2大問題。
1,提升使用者體驗,提高客戶查單效率
傳統的電商發貨需要客服手動選擇發貨的物流公司,利於單號識別API介面,我們可以智慧完成物流公司的選擇
2,節省客服維護成本,提高單號查詢精準度
我們經常會發現由於客戶誤選了快遞公司,導致運單軌跡無法獲取的原因,造成客戶的投訴,通過單號識別的智慧選擇可以起到輔助作用
下面具體講解實現過程.
1.完成前期準備工作
1.1,去快遞鳥官網免費註冊一個賬號
1.2,免費獲得一個apiKey(介面許可權驗證需要)
1.3,完成實名認證流程
1.4,訂購一個免費套餐
2.API介面
2.1,測試呼叫地址:http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
2.2,正式呼叫地址:http://api.kdniao.com/api/dist
2.3,請求方式:POST
2.4,編碼格式(utf-8):application/x-www-form-urlencoded;charset=utf-8
2.5,返回型別:JSON
2.6,除錯頁面:http://kdniao.com/UserCenter/v2/SandBox/TrackQuery.aspx
2.7,除錯工具:去除錯(使用快遞鳥賬號登入)
3.請求引數(Headers)
引數名稱 | 型別 | 說明 | 必須要求 |
---|---|---|---|
RequestData | String | 請求內容需進行URL(utf-8)編碼。請求內容JSON格式,須和DataType一致。 | R |
EBusinessID | String | 商戶ID,請在我的服務頁面檢視。 | R |
RequestType | String | 請求指令型別:2002 | R |
DataSign | String | 資料內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然後Base64編碼,最後 進行URL(utf-8)編碼。詳細過程請檢視Demo。 | R |
DataType | String | 請求、返回資料型別:只支援JSON格式 | R |
備註:R-必填(Required),O-可選(Optional),C-報文中該引數在一定條件下可選(Conditional)
4.請求引數(Body)
引數名稱 | 型別 | 說明 | 是否必須 |
---|---|---|---|
LogisticCode | String | 物流單號 | R |
5.返回引數(Return)
引數名稱 | 型別 | 說明 | 必須要求 | |
---|---|---|---|---|
EBusinessID | String | 電商使用者ID | R | |
LogisticCode | String | 物流單號 | R | |
Success | Bool | 成功與否 | R | |
Code | Int | 失敗原因 | O | |
Shipper | ShipperCode | String | 快遞公司編碼 | O |
ShipperName | String | 快遞公司名稱 | O |
6.請求報文(示例)
{
"LogisticCode": "3967950525457" }
7.成功返回報文(示例)
{
"EBusinessID": "1257021","Success": true,"LogisticCode": "3967950525457","Shippers": [
{
"ShipperCode": "YD","ShipperName": "韻達快遞"
}
]
}
8.分步講解(C#版本)
8.1,請求資料包結構
8.2,C#呼叫程式碼示例
//電商ID
string eEBusinessID = "test1617571";
//電商加密私鑰,快遞鳥提供,注意保管,不要洩漏
string appKey= "554343b2-7252-439b-b4eb-1af42c8f2175";
//請求url
string reqURL = "http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json";
//請求指令
string reqType="2002";
//2-json
string dataType = "2";
//字元編碼採用UTF-8
string charset = "UTF-8";
//JSON字串string
string jsonStr =
"{\\\"LogisticCode\\\":\\\"JT0000052600488\\\"}" ;
//把(jsonStr+APIKey)進行MD5加密
string md5Str=MD5(jsonStr + apiKey,charset);
//把md5Str 進行Base64編碼
string base64Str=base64(md5Str,charset);
//進行URL編碼 (utf-8)
string datasign = HttpUtility.UrlEncode(base64Str,charset);
//請求報文引數
string postStr = "RequestType=reqType&EBusinessID= eEBusinessID&RequestData=jsonStr
&DataSign= datasign&DataType=dataType";
//通訊協議使用Http協議Post請求方式 返回軌跡資料
string post = SendPost(reqURL,postStr);
//獲取到的post資料就是快遞鳥返回的完整報文,接下來自己寫一個解析json的方法就能獲取到裡面的欄位資訊。
8.3,C#呼叫方法
///<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));
}
/// <summary>
/// Post方式提交資料,返回網頁的原始碼
/// </summary>
/// <param name="url">傳送請求的 URL</param>
/// <param name="postData">請求報文引數</param>
/// <returns>遠端資源的響應結果</returns>
private string SendPost(string url,string postData)
{
string result = "";
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,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.ToString();
}
return result;
}
9.專案實際場景應用效果
10.關於簽名
快遞鳥和第三方電子商務公司系統進行對接,有一定的安全機制。採用 IP 認證加簽名
的方式對接,具體方案如下:
防止資料被篡改
在 POST 請求中會傳遞 5 個必須(R)引數
RequestData==資料內容(URL 編碼:UTF-8)
EBusinessID==使用者 ID
RequestType=請求指令型別
DataSign== 資料內容簽名:把(請求內容(未編碼)+ApiKey)進行 MD5 加密,然後 Base64
編碼,最後進行 URL(utf-8)編碼
DataType==2(返回資料型別為 json)
注:
DataSign 生成後,對方接收到資料後,以同樣的演算法進行簽名(推送介面 RequestType 為
101/102 不需要進行 URL 編碼),生成摘要,對比兩者的摘要是否相同,如果不同,說明傳遞過程中發生資料篡改。
呼叫介面的身份認證
註冊成為快遞鳥使用者後,會生成對應的使用者 ID 和 APIKey,使用者 ID 相當於使用者名稱,
APIKey 相當於密碼。