免費物流查詢接口API_調用案例

    目前快遞查詢接口對接需求較大,此博客做免費快遞接口做整理,並附上調用方式,如果有錯誤的地方,望溝通指教。


一.快遞查詢接口類型

    目前有提供免費快遞查詢接口的公司有:

快遞鳥

快遞100

快遞網

愛快遞

    這些快遞接口除了快遞鳥以外,都能夠免費查詢2000次/每天,快遞鳥接口每天請求次數都是沒有限制的,超過3000次/每天可以免費接入快遞鳥訂閱推送接口。查詢量較大的可以選擇快遞鳥接口。


二.對接流程

    以快遞鳥提供的即時查詢Api接口進行對接說明:

1.申請一個快遞鳥的賬號,進入http://www.kdniao.com/reg界面點擊免費申請

2.申請完成後即可獲得自己的KEY和ID,技術對接完成則可以正常使用

3.註冊信息必須填寫正確,如果有誤可能導致接口無法正常使用


三.對接案例

    主要對即時查詢API進行講解測試:

使用的是Chrome的postman插件進行Api測試調用

在JAVA環境下調用

在.net環境下調用


1.對接說明

1)打開http://www.kdniao.com/api-track查看Api接口定義文檔,瞭解url、請求參數及響應數據。 

2)API 所支持的快遞公司及編碼

3)請求地址:http://api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx


2.請求系統級參數說明


參數名稱類型說明必須要求
RequestDataString請求內容需進行URL(utf-8)編碼。請求內容JSON或XML格式,須和DataType一致。R
EBusinessIDString商戶ID,請在我的服務頁面查看。R
RequestTypeString請求指令類型:1002R
DataSignString數據內容簽名:把(請求內容(未編碼)+AppKey)進行MD5加密,然後Base64編碼,最後進行URL(utf-8)編碼。詳細過程請查看Demo。R
DataTypeString請求、返回數據類型:1-xml,2-json;默認爲xml格式O

備註:R-必填(Required),O-可選(Optional),C-報文中該參數在一定條件下可選(Conditional)。

 

3.接口參數

1)請求內容字段定義


參數類型說明必須要求
OrderCodeString訂單編號O
ShipperCodeString快遞公司編碼R
LogisticCodeString物流單號R



2)返回參數定義


參數名稱類型說明必須要求
EBusinessIDString用戶IDR
OrderCodeString訂單編號O
ShipperCodeString快遞公司編碼R
LogisticCodeString物流運單號R
SuccessBool成功與否R
ReasonString失敗原因O
StateString物流狀態:2-在途中,3-簽收,4-問題件R
Traces
TraceAcceptTimeString時間R
AcceptStationString描述R
RemarkString備註O


4.調用及圖例

1)postman插件進行Api測試調用

<?php

/**
 *
 * 快遞鳥物流軌跡即時查詢接口
 *
 * @技術QQ羣: 456320272
 * @see: http://www.kdniao.com/YundanChaxunAPI.aspx
 * @copyright: 深圳市快金數據技術服務有限公司
 *
 * DEMO中的電商ID與私鑰僅限測試使用,正式環境請單獨註冊賬號
 * 單日超過500單查詢量,建議接入我方物流軌跡訂閱推送接口
 * 
 * ID和Key請到官網申請:http://www.kdniao.com/ServiceApply.aspx
 */

//電商ID
defined('EBusinessID') or define('EBusinessID', '請到快遞鳥官網申請

http://www.kdniao.com/ServiceApply.aspx');
//電商加密私鑰,快遞鳥提供,注意保管,不要泄漏
defined('AppKey') or define('AppKey', '請到快遞鳥官網申請

http://www.kdniao.com/ServiceApply.aspx');
//請求url
defined('ReqURL') or define('ReqURL', 

'http://api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx');


//調用獲取物流軌跡
//-------------------------------------------------------------

$logisticResult = getOrderTracesByJson('STO', '3308083691559');
echo $logisticResult;

//-------------------------------------------------------------



/**
 * Json方式 查詢訂單物流軌跡
 */
function getOrderTracesByJson($shipperCode, $logisticCode){
	$requestData= "{\"OrderCode\":\"\",\"ShipperCode\":\"".

$shipperCode."\",\"LogisticCode\":\"".$logisticCode."\"}";
	$datas = array(
        'EBusinessID' => EBusinessID,
        'RequestType' => '1002',
        'RequestData' => urlencode($requestData) ,
        'DataType' => '2',
    );
    $datas['DataSign'] = encrypt($requestData, AppKey);
	$result=sendPost(ReqURL, $datas);	
	
	//根據公司業務處理返回的信息......
	
	return $result;
}

/**
 * XML方式 查詢訂單物流軌跡
 */
function getOrderTracesByXml(){
	$requestData= "<?xml version=\"1.0\" encoding=\"utf-8\" ?>".
						"<Content>".
						"<OrderCode></OrderCode>".
						

"<ShipperCode>SF</ShipperCode>".
						

"<LogisticCode>589707398027</LogisticCode>".
						"</Content>";
	
	$datas = array(
        'EBusinessID' => EBusinessID,
        'RequestType' => '1002',
        'RequestData' => urlencode($requestData) ,
        'DataType' => '1',
    );
    $datas['DataSign'] = encrypt($requestData, AppKey);
	$result=sendPost(ReqURL, $datas);	
	
	//根據公司業務處理返回的信息......
	
	return $result;
}
 
/**
 *  post提交數據 
 * @param  string $url 請求Url
 * @param  array $datas 提交的數據 
 * @return url響應返回的html
 */
function sendPost($url, $datas) {
    $temps = array();	
    foreach ($datas as $key => $value) {
        $temps[] = sprintf('%s=%s', $key, $value);		
    }	
    $post_data = implode('&', $temps);
    $url_info = parse_url($url);
    $httpheader = "POST " . $url_info['path'] . " HTTP/1.0\r\n";
    $httpheader.= "Host:" . $url_info['host'] . "\r\n";
    $httpheader.= "Content-Type:application/x-www-form-urlencoded\r\n";
    $httpheader.= "Content-Length:" . strlen($post_data) . "\r\n";
    $httpheader.= "Connection:close\r\n\r\n";
    $httpheader.= $post_data;
    $fd = fsockopen($url_info['host'], 80);
    fwrite($fd, $httpheader);
    $gets = "";
	$headerFlag = true;
	while (!feof($fd)) {
		if (($header = @fgets($fd)) && ($header == "\r\n" || $header 

== "\n")) {
			break;
		}
	}
    while (!feof($fd)) {
		$gets.= fread($fd, 128);
    }
    fclose($fd);    
    
    return $gets;
}

/**
 * 電商Sign簽名生成
 * @param data 內容   
 * @param appkey Appkey
 * @return DataSign簽名
 */
function encrypt($data, $appkey) {
    return urlencode(base64_encode(md5($data.$appkey)));
}

?>

填寫請求url及請求參數,下方就是響應的數據,效果圖如下:

wKiom1dznIayL1rSAAFaiFWCnwA370.png-wh_50



2)在JAVA環境下調用

package kdniaoApiDemo;
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; 



public class kdniaoTrackQueryAPI {
	
	//電商ID
	private String EBusinessID="ID請到官網申請:http://www.kdniao.com/ServiceApply.aspx";
	//電商加密私鑰,快遞鳥提供,注意保管,不要泄漏
	private String AppKey="Key請到官網申請:http://www.kdniao.com/ServiceApply.aspx";
	//請求url
	private String ReqURL="http://112.74.108.55/Ebusiness/EbusinessOrderHandle.aspx";	
	
	
	public static void main(String[] args) {
		// TODO Auto-generated method stub
		
		kdniaoTrackQueryAPI api = new kdniaoTrackQueryAPI();
		try {
			String result = api.getOrderTracesByJson("ZTO", "404461891208");
			System.out.print(result);
			
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
	
 
	/**
     * 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;
	}
	
	/**
     * XML方式 查詢訂單物流軌跡
	 * @throws Exception 
     */
	public String getOrderTracesByXml() throws Exception{
		String requestData= "<?xml version=\"1.0\" encoding=\"utf-8\" ?>"+
							"<Content>"+
							"<OrderCode></OrderCode>"+
							"<ShipperCode>SF</ShipperCode>"+
							"<LogisticCode>589707398027</LogisticCode>"+
							"</Content>";
		
		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", "1");
		
		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.setRequestProperty("kdniao-nocache", "true");
            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(); 
    }
}


調試結果如圖所示:

wKioL1dznM6jAQXYAAAcRV6h37o279.png-wh_50




3)在.net環境下調用

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using System.Web;
using System.Xml.XPath;




namespace Track
{
    class Program
    {

		static void Main(string[] args)
		{
			string result = t.getOrderTracesByJson(args[1], args

[0]);
			Console.WriteLine(result);
		}
		
		public class KdApiSearchDemo
		{
			//電商ID
			private string EBusinessID = "ID請到官網申請:

http://www.kdniao.com/ServiceApply.aspx";
			//電商加密私鑰,快遞鳥提供,注意保管,不要泄漏
			private string AppKey = "Key請到官網申請:

http://www.kdniao.com/ServiceApply.aspx";
			//請求url
			public string ReqURL = 

"http://120.24.74.29/Ebusiness/EbusinessOrderHandle.aspx";

			/// <summary>
			/// Json方式 查詢訂單物流軌跡
			/// </summary>
			/// <returns></returns>
			public string getOrderTracesByJson(string 

logisticsCode, string expCode)
			{
				string requestData = 

"{'OrderCode':'','ShipperCode':'" + expCode + "','LogisticCode':'" + 

logisticsCode + "'}";

				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(ReqURL, param);

				//根據公司業務處理返回的信息......

				return result;
			}

			/// <summary>
			/// XML方式 查詢訂單物流軌跡
			/// </summary>
			/// <returns></returns>
			public string getOrderTracesByXml(string expCode, 

string logisticsCode)
			{
				string requestData = "<?xml version=\"1.0\" 

encoding=\"utf-8\" ?>" +
									

"<Content>" +
									

"<OrderCode></OrderCode>" +
									

"<ShipperCode>" + expCode + "</ShipperCode>" +
									

"<LogisticCode>" + logisticsCode + "</LogisticCode>" +
									

"</Content>";

				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", "1");

				string result = sendPost(ReqURL, 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);
					}
				}
				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));
			}
		}
	}
}		


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章