上一篇文章我們介紹了一個物流服務提供商,推薦大家使用快遞鳥接口,主要介紹了如何注冊賬號,獲得密鑰,找不到注冊地址的,我在發一下:
之前也聊過如何利用快遞鳥提供的接口來實現即時查詢。也提供了C#代碼,這次我們用Java來實現接口對接,
在開發之前,我們先來了解一下什么是即時查詢,按我的理解就是,我們提供運單號和快遞公司編碼,然后調用快遞鳥提供的查詢接口,即可查詢運單號的發貨情況,我們可以通過這個接口獲悉到包裹的收件時間,派送時間,簽收時間,簽收人,如果體驗做的更好一點,通過大數據可以分析這個包裹的預計派送時間。
以下是我通過調用快遞鳥接口提供的即時查詢接口獲得的內容:
外觀顯示效果可以忽略,這是我項目應用的截圖,我們得到軌跡信息以后,可以按自己的頁面風格最終呈現給客戶。
好了,現在我們來聊一聊具體實現吧!
首先我們准備好需要用到的資源,
測試商戶ID:
test1617571
測試API key:
554343b2-7252-439b-b4eb-1af42c8f2175(此Key僅限測試環境使用)
API測試地址:
http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
我們先來解讀一下快遞鳥官網提供的接口文檔說明
這個使用流程圖我是在快遞鳥官網截圖的,我們先來梳理一下幾個角色
1, 用戶,這個很好理解,就是我們這群開發人員,苦逼的程序員
2, 快遞鳥,這個寫的也很清楚了,就是物流服務提供商
3, 客戶,這是我們自己的客戶,我們得到快遞鳥的數據以后是需要內部封裝,通過各種界面展示給我們真正的上帝看的,客戶看到的是我們再次封裝的信息,當然如果你想把快遞鳥返回的信息直接暴露給你的客戶看,我也不反對。只能說,你是最棒的。
接下來,我們講解一下請求參數
請求系統級參數說明:
備注:R-必填(Required),O-可選(Optional),C-報文中該參數在一定條件下可選(Conditional)
這里提到了系統級參數,也相當於是公用參數,這些參數是調用每個接口都是必須要傳參的。
接口參數:
接口參數,也叫業務參數,請求的業務接口不同,參數的字段,內容也不同,是跟着業務變化的,這里我們實現的是即時查詢接口,快遞鳥官網要求必須傳遞快遞公司編碼和物流單號
物流單號很好理解,就是快遞面單上的運單號,快遞公司編碼是必須傳遞快遞鳥支持的編碼,你可能會問,我如何能知道快遞鳥支持哪些快遞公司,不急,馬上告訴你。
下載快遞公司編碼:
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 }
Java關鍵代碼:
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();
}
}
附上詳細的接口文檔給大家:
http://www.kdniao.com/documents