澳邮快递单号查询接⼝-快递鸟API澳邮中国
前⾔
看完快递鸟api澳邮中国对接教程这篇⽂章,把源码复制到项⽬上,就能快速完成接⼝对接,适合刚⼊门的菜鸟,调⽤快递鸟的澳邮中国查询API接⼝,能查询到澳邮中国单号从收件、运输,到转运中⼼,派送到签收等各个环节的物流发货状态。快递鸟api接⼝不区分开发语⾔,⽀持Java,C#,PHP,Python,ObjectC等开发语⾔的程序调⽤。下⾯具体讲解实现过程.
⽬录
1.完成前期准备⼯作
2.API接⼝
3.请求参数(Headers)
4.请求参数(Body)
5.返回参数(Return)
6.请求完整报⽂(⽰例)
7.成功返回报⽂(⽰例)
8.失败返回报⽂(⽰例)
9.⽆轨迹返回报⽂(⽰例)
10.分步讲解(C#版本)
11.关于签名
1.完成前期准备⼯作
1.1,去快递鸟官⽹免费注册⼀个账号
1.2,免费获得⼀个apiKey(接⼝权限验证需要)
1.3,完成实名认证流程
1.4,订购⼀个免费套餐
2.API接⼝
2.3,请求⽅式:POST
2.4,编码格式(utf-8):application/x-www-form-urlencoded;charset=utf-8
2.5,返回类型:JSON
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':'AUEX','LogisticCode':'ZA02673754999'}
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%27AUEX%27%2c%27LogisticCode%27%3a%27ZA02673754999%27%7d&EBusinessID=1264783& RequestType=1002&DataSign=MjdjZTg5ZDJiMzliYjY0YmY2NjAyZGMzYWUzODIwZjk%3d&DataType=2
7.成功返回报⽂(⽰例)
{
"LogisticCode": "ZA02673754999",
"ShipperCode": "AUEX",
"Traces": [
{
"AcceptStation": "运单已创建, 等待收货",
"AcceptTime": "2020-03-24 11:15:43"
},
{
"AcceptStation": "运单扫描,正在分拣",
"AcceptTime": "2020-03-29 16:00:47"
},
{
"AcceptStation": "预分配转运单号",
"AcceptTime": "2020-03-29 16:00:47"
},
{
"AcceptStation": "运单详情已录⼊系统",
"AcceptTime": "2020-03-29 16:00:52"
},
{
"AcceptStation": "已安排航班",
"AcceptTime": "2020-03-29 16:00:52"
},
{
"AcceptStation": "货物打板装车,准备运往机场",
"AcceptTime": "2020-03-29 19:03:56"
},
{
"AcceptStation": "货物已送机场",
"AcceptTime": "2020-04-05 18:00:29"
},
{
"AcceptStation": "提交清关申报材料,清关处理中",
"AcceptTime": "2020-04-14 09:16:14"
},
{
"AcceptStation": "清关处理中",
"AcceptTime": "2020-04-16 10:35:40"
},
{
"AcceptStation": "清关处理中",
"AcceptTime": "2020-04-18 12:36:56"
},
{
"AcceptStation": "清关处理中",
"AcceptTime": "2020-04-20 08:02:48"
},
{
"AcceptStation": "清关处理中",
"AcceptTime": "2020-04-22 11:13:21"
},
{
"AcceptStation": "清关处理中",
"AcceptTime": "2020-04-24 09:27:54"
},
{
"AcceptStation": "清关处理中",
"AcceptTime": "2020-04-26 08:23:09"
},
{
"AcceptStation": "清关处理中",
"AcceptTime": "2020-04-28 11:08:29"
}
],
"State": "2",
"EBusinessID": "1264783",
"Success": true
}
8.失败返回报⽂(⽰例)
{
"LogisticCode": "ZA02673754999", "ShipperCode": "AUEX", "Traces": [], "State": "0", "EBusinessID": "1264783", "Reason": "业务错误[没有可⽤套餐]", "Success": false }
说明:未实名认证,未订购套餐,套餐可⽤查询量已经⽤完都会返回此报⽂信息
/
9.⽆轨迹返回报⽂(⽰例)
{ "LogisticCode" : "ZA02673754999", "ShipperCode" : "AUEX", "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 = "sandboxapi.kdniao: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\":\"AUEX\",\"LogisticCode\":\"ZA02673754999\"}" ;
//把(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 相当于密码。