第三方接口快递鸟-即时查询
第三方接口快递鸟-即时查询
一：简介
快递鸟集合全球1600+家快递物流公司的线路、电子面单、下单、轨迹、货款等接口，为电商平台，ERP，仓配，清关公司提供统一物流接口服务，一次性解决电商的物流管理和线下支付问题。”
应用场景：
- 在移动端APP、小程序上输入框与查询按钮，实现即时物流信息查询。
- 在网页上使用输入框与查询按钮，实现即时物流信息查询。
- 主流快递公司，无需传快递编码，自动识别物流公司返回物流轨迹。
使用流程：
接下来我们先了解一下这个API的对接流程
二：使用
1：注册认证账号
在使用之前我们先要注册快递鸟，
注册完以后会给我们生成一个用户ID和key,这两个信息后面我们代码中是要使用的，如图所示：
点击图的“ 0元点击开通 ”可以体验新客福利。
2：申请服务
点击图的“ 0元点击开通 ”可以体验新客福利。
3：技术对接
API参数
1.接口描述/说明
- 查询接口支持按照运单号查询(单个查询)。
- 接口需要指定快递单号，格式不对或则编码错误都会返失败的信息。主流13家不需要选择快递公司编码，其他需要选择快递公司编码，查看快递公司编码。
- 返回的物流跟踪信息按照发生的时间升序排列。
- 接口指令8002。
- 接口支持的消息接收方式为HTTP POST，请求方法的编码格式(utf-8)：“application/x-www-form-urlencoded;charset=utf-8”。
- 测试地址：http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInvoke.json
- 正式地址：https://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx
请求系统级参数说明：
| 参数名称 | 类型 | 说明 | 必要条件 |
|---|---|---|---|
| RequestData | String | 请求内容需进行URL(utf-8)编码。请求内容JSON格式，须和DataType一致。 | 是 |
| EBusinessID | String | 商户ID，请在我的服务页面查看。 | 是 |
| RequestType | String | 请求指令类型：8002 | 是 |
| DataSign | String | 数据内容签名：把(请求内容(未编码)+AppKey)进行MD5加密，然后Base64编码，最后 进行URL(utf-8)编码。详细过程请查看Demo。 | 是 |
| DataType | String | 请求、返回数据类型：2-json； | 否 |
2.接口参数
| 参数名称 | 类型 | 说明 | 必要条件 |
|---|---|---|---|
| OrderCode | String | 订单编号 | 否 |
| CustomerName | String | ShipperCode 为JD，必填，对应京东的青龙配送编码，也叫商家编码，格式：数字＋字母＋数字，9 位数字加一个字母，共10 位，举例：001K123450；ShipperCode 为SF，且快递单号非快递鸟渠道返回时，必填，对应收件人/寄件人手机号后四位；ShipperCode 为SF，且快递单号为快递鸟渠道返回时，不填；ShipperCode 为其他快递时，不填 | 可选 |
| ShipperCode | String | 快递公司编码 | 否 |
| LogisticCode | String | 物流单号 | 是 |
接口返回参数定义请参考：即时查询API
4：测试联调
1.创建快递实体
本实体字段根据API文档编写
/**
* @author gf
* @date 2022/7/20
*/
@Data
public class Express {
/**
* 应用级参数
**/
@Field(name = "订单编号")
private String OrderCode;
@Field(name = "hipperCode为SF时必填，需要在CustomerName赋值单号对应的寄件人或收件人的手机号后四位数字")
private String CustomerName;
@Field(name = "快递公司编码 详细编码参考《快递鸟接口支持快递公司编码.xlsx》")
private String ShipperCode;
@Field(name = "快递单号")
private String LogisticCode;
/**
* 系统级参数
**/
@Field(name = "请求内容为JSON格式 详情可参考接口技术文档：https://www.kdniao.com/documents")
private String RequestData;
@Field(name = "用户ID")
private String EBusinessID;
@Field(name = "请求接口指令")
private String RequestType;
@Field(name = "数据内容签名，加密方法为：把(请求内容(未编码)+ApiKey)进行MD5加密--32位小写，然后Base64编码，最后进行URL(utf-8)编码")
private String DataSign;
@Field(name = "DataType=2，请求、返回数据类型均为JSON格式")
private String DataType;
}
2.编写接口
这里是引用
/**
* @技术QQ群: 可登录官网https://www.kdniao.com/右侧查看技术群号
* @see: https://kdniao.com/api-trackexpress
* @copyright: 深圳市快金数据技术服务有限公司
* ID和Key请到官网申请：https://kdniao.com/reg
* 快递查询接口
* 此接口用于向快递公司实时查询物流轨迹信息。该功能支持情况需查看技术文档。
* 正式地址：https://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx
*
*
* 系统级参数
* RequestData String R 请求内容为JSON格式 详情可参考接口技术文档：https://www.kdniao.com/documents
* EBusinessID String R 用户ID
* RequestType String R 请求接口指令
* DataSign String R 数据内容签名，加密方法为：把(请求内容(未编码)+ApiKey)进行MD5加密--32位小写，然后Base64编码，最后进行URL(utf-8)编码
* DataType String R DataType=2，请求、返回数据类型均为JSON格式
* 应用级参数
* R-必填（Required），O-可选（Optional），C-报文中该参数在一定条件下可选（Conditional）
* OrderCode String(30) O 订单编号
* CustomerName String(50) C ShipperCode为SF时必填，需要在CustomerName赋值单号对应的寄件人或收件人的手机号后四位数字
* ShipperCode String(10) O 快递公司编码 详细编码参考《快递鸟接口支持快递公司编码.xlsx》
* LogisticCode String(30) R 快递单号
*
*
* 请求示例
* ZTO请求示例：
* {
* "OrderCode": "",
* "LogisticCode": "638650888018",
* }
*
* JD请求示例：
* {
* "OrderCode": "",
* "CustomerName": "",
* "LogisticCode": "JDVA00003618100",
* }
*
* SF请求示例：
* {
* "OrderCode": "",
* "CustomerName": "1234",
* "LogisticCode": "SF00003618100",
* }
*/
public class KdApiExpressSearch {
//用户ID，快递鸟提供，注意保管，不要泄漏
private String EBusinessID="1769669";//即用户ID，登录快递鸟官网会员中心获取 https://www.kdniao.com/UserCenter/v4/UserHome.aspx
//API key，快递鸟提供，注意保管，不要泄漏
private String ApiKey="814f7f64-a764-4766-8732-0922cf785bd6";//即API key，登录快递鸟官网会员中心获取 https://www.kdniao.com/UserCenter/v4/UserHome.aspx
//请求url, 正式环境地址
private String ReqURL="https://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx";
public static void main(String[] args) {
try {
KdApiExpressSearch api = new KdApiExpressSearch();
// 组装请求参数
Express express = new Express();
express.setOrderCode("1616224729075455868");// 订单号
express.setLogisticCode("773170861031705"); // 快递单号
System.out.println(api.getExpressResult(express));
} catch (Exception e) {
e.printStackTrace();
}
}
public String getExpressResult(Express express)throws Exception{
if(express==null){
new IllegalArgumentException("请求参数为空");
}
String RequestData = express.toString();
// 组装系统级参数
Map<String,String> params = new HashMap<String,String>();
params.put("RequestData", urlEncoder(RequestData, "UTF-8"));
params.put("EBusinessID", EBusinessID);
params.put("RequestType", "8002");//快递查询接口指令8002/地图版快递查询接口指令8004
String dataSign=encrypt(RequestData, ApiKey, "UTF-8");
params.put("DataSign", urlEncoder(dataSign, "UTF-8"));
params.put("DataType", "2");
// 以form表单形式提交post请求，post请求体中包含了应用级参数和系统级参数
String result=sendPost(ReqURL, params);
//根据公司业务处理返回的信息......
return result;
}
/**
* MD5加密
* str 内容
* 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编码
* str 内容
* charset 编码方式
* @throws UnsupportedEncodingException
*/
private String base64(String str, String charset) throws UnsupportedEncodingException{
String encoded = Base64.encode(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签名生成
* content 内容
* keyValue ApiKey
* 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方法的请求
* url 发送请求的 URL
* 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();
}
}
3.测试
可用淘宝，京东，顺丰任意物流单号查询
执行上面的main方法
返回结果：
{
“OrderCode”: “1616224729075455868”,
“EBusinessID”: “1769669”,
“ShipperCode”: “STO”,
“LogisticCode”: “773170861031705”,
“State”: “3”,
“StateEx”: “301”,
“Location”: “西安市”,
“Traces”: [{
“Action”: “1”,
“AcceptStation”: “【浙江义乌公司】的收件员【吉洋洋(15617010755)】已收件”,
“AcceptTime”: “2022-07-14 18:50:33”,
“Location”: “金华市”
}, {
“Action”: “2”,
“AcceptStation”: “快件由【浙江义乌公司】发往【浙江金华转运中心】”,
“AcceptTime”: “2022-07-14 19:30:46”,
“Location”: “金华市”
}, {
“Action”: “2”,
“AcceptStation”: “快件已到达【浙江金华转运中心】扫描员是【进港自动化】”,
“AcceptTime”: “2022-07-15 07:32:49”,
“Location”: “金华市”
}, {
“Action”: “2”,
“AcceptStation”: “快件由【浙江金华转运中心】发往【陕西西安转运中心】，包裹已消杀”,
“AcceptTime”: “2022-07-15 15:32:49”,
“Location”: “金华市”
}, {
“Action”: “2”,
“AcceptStation”: “快件已到达【陕西西安转运中心】扫描员是【牛二望】”,
“AcceptTime”: “2022-07-16 07:33:29”,
“Location”: “咸阳市”
}, {
“Action”: “2”,
“AcceptStation”: “快件由【陕西西安转运中心】发往【陕西西安东郊一公司】，包裹已消杀”,
“AcceptTime”: “2022-07-16 07:43:47”,
“Location”: “咸阳市”
}, {
“Action”: “2”,
“AcceptStation”: “快件已到达【陕西西安东郊一公司】扫描员是【曾航】”,
“AcceptTime”: “2022-07-16 15:30:15”,
“Location”: “西安市”
}, {
“Action”: “202”,
“AcceptStation”: “【陕西西安东郊一公司】的派件员【曾航(18292038519)】正在为您派件，如有疑问请联系派件员，联系电话【18292038519】，快件已消毒，申通小哥已测体温，请放心收寄快递（95132，95089为申通业务员外呼专属号码，可放心接听）”,
“AcceptTime”: “2022-07-16 15:32:15”,
“Location”: “西安市”
}, {
“Action”: “211”,
“AcceptStation”: “快件已由西安罗马嘉园南门商铺店菜鸟驿站代收，请及时取件，如有疑问请联系17391584867”,
“AcceptTime”: “2022-07-16 16:48:35”,
“Location”: “西安市”
}, {
“Action”: “301”,
“AcceptStation”: “已签收，签收人凭取货码签收。”,
“AcceptTime”: “2022-07-17 11:48:49”,
“Location”: “西安市”
}],
“DeliveryMan”: “曾航”,
“DeliveryManTel”: “18292038519”,
“Success”: true
}
5：感慨
十年生死两茫茫
曾经我是 bug王