天天看點

快遞單号智能識别API接口

單号識别API接口,主要也是為了提供使用者使用體驗,減少客戶操作步驟,以及人工查錯,客戶提供快遞單号,即可實時傳回可能的一個或多個快遞公司,存在多個快遞公司結果的,大資料平台根據可能性、單号量,進行智能排序。我們在PC端、移動端應用或網站應用內建運單物流資訊查詢功能時,隻需要錄入單号即可完成查詢,無需使用者輸入快遞公司。這個接口解決了我2大問題。

前言

單号識别API接口,主要也是為了提供使用者使用體驗,減少客戶操作步驟,以及人工查錯,客戶提供快遞單号,即可實時傳回可能的一個或多個快遞公司,存在多個快遞公司結果的,大資料平台根據可能性、單号量,進行智能排序。我們在PC端、移動端應用或網站應用內建運單物流資訊查詢功能時,隻需要錄入單号即可完成查詢,無需使用者輸入快遞公司。這個接口解決了我2大問題。

1,提升使用者體驗,提高客戶查單效率

傳統的電商發貨需要客服手動選擇發貨的物流公司,利于單号識别API接口,我們可以智能完成物流公司的選擇

2,節省客服維護成本,提高單号查詢精準度

我們經常會發現由于客戶誤選了快遞公司,導緻運單軌迹無法擷取的原因,造成客戶的投訴,通過單号識别的智能選擇可以起到輔助作用

下面具體講解實作過程.

目錄

1.完成前期準備工作

2.API接口

3.請求參數(Headers)

4.請求參數(Body)

5.傳回參數(Return)

6.請求封包(示例)

7.成功傳回封包(示例)

8.分步講解(C#版本)

9.項目實際場景應用效果

10.關于簽名

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,請求資料包結構

快遞單号智能識别API接口

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, 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.ToString();
        }
        return result;
    }
      

9.項目實際場景應用效果

快遞單号智能識别API接口

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 相當于密碼。