如何利用快递鸟提供的接口来查询韵达快递的物流轨迹。
讲解之前我们来看一下,接口完成以后的实际显示效果
以下是产品应用截图,调用快递鸟接口获得的轨迹信息:
实际上快递鸟返回的报文信息会更详细,在给客户展示的信息可根据产品需要来封装返回轨迹信息。
现在我们来聊一聊具体实现!
首先我们准备好需要用到的资源,
测试商户ID:
test1617571
测试API key:
554343b2-7252-439b-b4eb-1af42c8f2175(此Key仅限测试环境使用)
API测试地址:
http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
我以C#开发为例来讲解
接下来,我们讲解一下请求参数
请求系统级参数说明:
备注:R-必填(Required),O-可选(Optional),C-报文中该参数在一定条件下可选(Conditional)
这里提到了系统级参数,也相当于是公用参数,这些参数是调用每个接口都是必须要传参的。
接口参数:
接口参数,也叫业务参数,请求的业务接口不同,参数的字段,内容也不同,是跟着业务变化的,这里我们实现的是即时查询接口,请求指令类型:1002,快递鸟官网要求必须传递快递公司编码和物流单号 ,圆通快递的编码是YD
如要查看其他快递公司的编码,点击此链接:
http://www.kdniao.com/documents
正如我前面的轨迹截图,韵达快递的编码是YD,物流单号是4602132422443
业务参数报文组合如下:
{'OrderCode':'','ShipperCode':'YD','LogisticCode':'4602132422443'}
请求的完整报文(URL编码以后):
RequestData=%0d%0a++++++++++++%7b%27OrderCode%27%3a%27%27%2c%27ShipperCode%27%3a%27YD%27%2c%27LogisticCode%27%3a%274602132422443%27%7d%0d%0a++++++++&EBusinessID=1617571&RequestType=1002&DataSign=NTE2NzQzODkwNDE3MzcxZDRhNDdmMTIzMDg0MGZkODA%3d&DataType=2
未编码的请求报文:
RequestData=
{'OrderCode':'','ShipperCode':'YD','LogisticCode':'4602132422443'}
&EBusinessID=1617571&RequestType=1002&DataSign=NTE2NzQzODkwNDE3MzcxZDRhNDdmMTIzMDg0MGZkODA=&DataType=2
返回的报文信息:
`{
"LogisticCode": "4602132422443", "ShipperCode": "YD", "Traces": [ { "AcceptStation": "【武汉市】 湖北市场部大智公司志翔分部-胡坤(18671561151) 已揽收", "AcceptTime": "2020-01-16 17:21:14" }, { "AcceptStation": "【武汉市】 已到达 湖北武汉分拨中心", "AcceptTime": "2020-01-17 04:04:57" }, { "AcceptStation": "【武汉市】 已离开 湖北武汉分拨中心 发往 深中地区包", "AcceptTime": "2020-01-17 05:09:38" }, { "AcceptStation": "【武汉市】 已离开 湖北武汉分拨中心 发往 广东深圳公司南山区欢乐谷分部", "AcceptTime": "2020-01-17 23:37:28" }, { "AcceptStation": "【深圳市】 已到达 广东深圳公司", "AcceptTime": "2020-01-19 00:12:00" }, { "AcceptStation": "【深圳市】 已离开 广东深圳公司 发往 广东深圳公司龙华区白石龙分拨分部(13530675811)", "AcceptTime": "2020-01-19 00:22:53" }, { "AcceptStation": "【深圳市】 已离开 广东深圳公司龙华区白石龙分拨分部 发往 广东深圳公司龙岗区民治鑫茂分部(0755-61884821|15012728905)", "AcceptTime": "2020-01-19 05:34:03" }, { "AcceptStation": "【深圳市】 广东深圳公司龙岗区民治鑫茂分部 派件员 庄泽秋(13411074145)正在为您派送", "AcceptTime": "2020-01-19 21:37:14" }, { "AcceptStation": "【代收点】您的快件已送达 鑫茂花园A区2栋1单元负一楼门口2号丰巢智能柜FC75518713保管,地址:鑫茂花园A区2栋1单元负一楼门口2号丰巢智能柜 如有疑问请电联快递员 庄泽秋(13411074145) 投诉电话: 021-39209001", "AcceptTime": "2020-01-19 21:55:47" }, { "AcceptStation": "【代收点】您的快件已签收,签收人在鑫茂花园A区2栋1单元负一楼门口2号丰巢智能柜FC75518713(鑫茂花园A区2栋1单元负一楼门口2号丰巢智能柜)领取,投诉电话:021-39209001", "AcceptTime": "2020-01-20 11:15:10" } ], "State": "3", "EBusinessID": "1264783", "Success": true
}`
C#关键代码:
`/// <summary>
/// 即时查询物流轨迹
/// </summary>
/// <param name="url">http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json</param>
/// <param name="eBusinessID">test1617571</param>
/// <param name="appKey">554343b2-7252-439b-b4eb-1af42c8f2175</param>
/// <param name="requestData">{'OrderCode':'','ShipperCode':'ZTO','LogisticCode':'78120038107849'}</param>
/// <returns></returns>
public string getOrderTracesByJson(string url,string eBusinessID, string appKey, string requestData)
{
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(url, 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);
}
}
// return postData.ToString();
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));
}`