澳洲飛躍快遞單號查詢快遞鳥API介面-澳洲飛躍
前言
看完快遞鳥api澳洲飛躍對接教程這篇文章,把原始碼複製到專案上,就能快速完成介面對接,適合剛入門的菜鳥,呼叫快遞鳥的澳洲飛躍查詢API介面,能查詢到澳洲飛躍單號從收件、運輸,到轉運中心,派送到簽收等各個環節的物流發貨狀態。快遞鳥api介面不區分開發語言,支援Java,C#,PHP,Python,ObjectC等開發語言的程式呼叫。下面具體講解實現過程.
目錄
1.完成前期準備工作
1.1,去快遞鳥官網免費註冊一個賬號
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一致 | 必填 |
EBusinessID | String | 使用者ID,檢視使用者ID和ApiKey | 必填 |
RequestType | String | 請求指令型別:1002 | 必填 |
DataSign | String | 簽名資料,(Body+ApiKey)進行MD5加密,再進行Base64編碼,最後進行URL(utf-8)編碼 | 必填 |
DataType | String | 求、返回資料型別:2-json ,預設Json | 選填 |
4.請求引數(Body)
引數名稱 | 型別 | 說明 | 必須要求 |
OrderCode | String | 訂單編號 | 選填 |
ShipperCode | String | 快遞公司編碼 | 必填 |
LogisticCode | String | 物流運單號 | 必填 |
引數報文:
{‘OrderCode‘:‘‘,‘ShipperCode‘:‘RLG‘,‘LogisticCode‘:‘RLG12361628‘}
5.返回引數(Return)
引數名稱 | 型別 | 說明 | 必須要求 |
EBusinessID | String | 使用者ID | 必填 |
ShipperCode | String | 快遞公司編碼 | 必填 |
LogisticCode | String | 物流運單號 | 選填 |
Success | String | 成功與否 | 必填 |
Reason | String | 失敗原因 | 選填 |
State | String | 物流狀態:2-在途中,3-簽收,4-問題件 | 必填 |
Traces | String | 時間 | |
AcceptTime | String | 必填 | |
AcceptStation | String | 描述 | 選填 |
Remark | String | 備註 | 必填 |
6.請求完整報文(示例)
RequestData=%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27RLG%27%2c%27LogisticCode%27%3a%27RLG12361628%27%7d&EBusinessID=1264783&RequestType=1002&
DataSign=NzliMWZlZmI4OGVjMjFlM2I3M2ZmYzBiMTQzMjJkN2E%3d&DataType=2
7.成功返回報文(示例)
{
"LogisticCode": "RLG12361628",
"ShipperCode": "RLG",
"Traces": [
{
"AcceptStation": "運單已建立資訊已錄入 ",
"AcceptTime": "2020-03-26 15:35:00"
},
{
"AcceptStation": "貨物已入倉 ",
"AcceptTime": "2020-03-26 19:37:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0327 ",
"AcceptTime": "2020-03-27 14:00:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0328 ",
"AcceptTime": "2020-03-28 13:00:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0329 ",
"AcceptTime": "2020-03-29 16:00:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0330 ",
"AcceptTime": "2020-03-30 14:00:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0331 ",
"AcceptTime": "2020-03-31 14:00:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0401 ",
"AcceptTime": "2020-04-01 14:00:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0402 ",
"AcceptTime": "2020-04-02 14:00:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0403 ",
"AcceptTime": "2020-04-03 14:00:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0404 ",
"AcceptTime": "2020-04-04 16:30:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0405 ",
"AcceptTime": "2020-04-05 14:00:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0406 ",
"AcceptTime": "2020-04-06 14:00:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0407 ",
"AcceptTime": "2020-04-07 14:00:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0408 ",
"AcceptTime": "2020-04-08 14:00:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0409 ",
"AcceptTime": "2020-04-09 14:00:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0410 ",
"AcceptTime": "2020-04-10 19:00:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0411 ",
"AcceptTime": "2020-04-11 11:00:00"
},
{
"AcceptStation": "請儘快上傳錢菁菁身份證0412 ",
"AcceptTime": "2020-04-12 11:15:00"
},
{
"AcceptStation": "貨物分揀中 ",
"AcceptTime": "2020-04-14 10:54:00"
},
{
"AcceptStation": "貨物安檢中 ",
"AcceptTime": "2020-04-16 10:00:00"
},
{
"AcceptStation": "貨物離港 ",
"AcceptTime": "2020-04-18 11:43:00"
},
{
"AcceptStation": "貨物中轉 ",
"AcceptTime": "2020-04-21 17:08:00"
},
{
"AcceptStation": "貨物抵達 ",
"AcceptTime": "2020-04-23 19:12:00"
},
{
"AcceptStation": "貨物進入海關監管倉 ",
"AcceptTime": "2020-04-24 15:49:00"
},
{
"AcceptStation": "貨物開始清關等待放行 ",
"AcceptTime": "2020-04-26 09:00:00"
},
{
"AcceptStation": "貨物清關中,等待放行 ",
"AcceptTime": "2020-04-28 09:24:00"
}
],
"State": "2",
"EBusinessID": "1264783",
"Success": true
}
8.失敗返回報文(示例)
{ "LogisticCode": "RLG12361628","ShipperCode": "RLG","Traces": [],"State": "0","EBusinessID": "1264783","Reason": "業務錯誤[沒有可用套餐]","Success": false }
說明:未實名認證,未訂購套餐,套餐可用查詢量已經用完 都會返回此報文資訊
去實名認證/瞭解套餐詳情
9.無軌跡返回報文(示例)
{ "LogisticCode" : "1RLG12361628","ShipperCode" : "RLG","Traces" : [ ],"State" : "0","EBusinessID" : "1264783","Reason" : "暫無軌跡資訊","Success" : true }
10.分步講解(C#版本)
10.1,請求資料包結構
10.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="1002";
//2-json
string dataType = "2";
//字元編碼採用UTF-8
string charset = "UTF-8";
//JSON字串string
string jsonStr =
"{\"OrderCode\":\"\",\"ShipperCode\":\"JTSD\",\"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的方法就能獲取到裡面的欄位資訊。
10.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;
}
11.關於簽名
快遞鳥和第三方電子商務公司系統進行對接,有一定的安全機制。採用 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 相當於密碼。