申请快递鸟账户
-
附上 快递鸟官网账号登陆地址
-
然后呢,进行注册登陆,以及实名认证。我这边因为已经认证过了,所以显示的已认证,点击这个地方,达到已认证之后,使用右方的用户ID和API key进行之后的接口调用。
引入查询Demo
- 进入快递鸟官网的API文档中心,选择 即时查询API,点击demo下载。
-
这里有挺三种demo提供下载,我们以java为例,下载java版,下载完成之后,导入到Eclipse中。
-
接口技术文档可以下载查看,里面有对各个接口的使用,示例以及返回结果的展示。
-
查看快递公司编码,这个快递公司编码在之后的查询中我们需要使用。
-
需要注意的是,在没有钞能力之前,我们进行查询的快递只有四种——申通,天天,圆通和百世。
项目搭建
-
打开Eclipse,创建一个Dynamic Web Project ,命名KDAPI。
-
可根据自己的需求,建立以下的几个文件:
-
其中KdniaoTrackQueryApi中的文件是我们从官方进行下载的即时查询的demo源文件,直接进行复制即可,不过在后续我们会对其进行一些更改。
-
我们把KdniaoTrackQueryApi中的main方法剪切并粘贴在Query文件中,输入一个快递公司的编码和快递号进行查询,并查看结果。
-
这个时候的结果很显然是不尽人意的,因为JSON的形式不利于用户的观看,所以我们在web查询页面进行展示的时候,还需要对其进行转变,使普通用户也可以很方便的查看快递信息。
-
所以我们再来对KdniaoTrackQueryApi文件中的getOrderTracesByJson方法进行改造。删除最后的return result,并添加如下代码:
String show = "";
try {
JSONObject obj = JSONObject.parseObject(result);
boolean bool = obj.getBooleanValue("Success");
if (!bool) {
show = "暂时无法查询到该物流轨迹信息。";
} else {
JSONArray arr = obj.getJSONArray("Traces");
for (int i = 0; i < arr.size(); i++) {
JSONObject o = (JSONObject) arr.get(i);
show = show + o.getString("AcceptTime") + "<br/>";
show = show + o.getString("AcceptStation") + "<br/><br/>";
}
}
}catch (Exception e) {
e.printStackTrace();
}
return show;
- JSON转变之后,基本就可以正常显示了。
- 由于用户ID和API秘钥比较私密(如果你花钱购买了增值服务的话),所以就需要用一个api.properties文件存储我们的信息,然后在文件中读取即可。
- 以上内容完成后,我们就可以创建一个Servlet文件来处理请求了。
- 那么请求都应该包含哪些内容呢?根据快递鸟官方提供的即时查询的API,我们可以发现只需要提供两个内容即可——快递公司编码和快递单号,那么前端的布局就产生了。
- 建立index.jsp,在jsp文件中创建一个表单(用来把数据传到Servlet中,因为目前我只会这一种传输方法,所以就只能用这个了),嵌套一个input的text输入传输快递单号。
- 因为我们是试用版的用户,所以我们只有四种快递可以选,那么我们就选择四个单选按钮来传输快递公司的值。
- 接受这些内容之后,我们在Servlet中执行以下方法即可:
response.setContentType("text/html;charset=utf-8");
KdniaoTrackQueryAPI api = new KdniaoTrackQueryAPI();
String expCode = request.getParameter("type");
String expNo = request.getParameter("searchArea");
String res = null;
try {
res = api.getOrderTracesByJson(expCode, expNo);
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
response.getWriter().write(res);
效果展示
百世快递
圆通快递
资源下载
完整的KdniaoTrackQueryApi.java
package com.zy.api;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
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;
import java.util.Properties;
import com.alibaba.fastjson.JSONArray;
import com.alibaba.fastjson.JSONObject;
/**
*
* 快递鸟物流轨迹即时查询接口
*
* @技术QQ群: 456320272
* @see: http://www.kdniao.com/YundanChaxunAPI.aspx
* @copyright: 深圳市快金数据技术服务有限公司
*
* DEMO中的电商ID与私钥仅限测试使用,正式环境请单独注册账号
* 单日超过500单查询量,建议接入我方物流轨迹订阅推送接口
*
* ID和Key请到官网申请:http://www.kdniao.com/ServiceApply.aspx
*/
public class KdniaoTrackQueryAPI {
public static Map<String, String> params = new HashMap<String, String>();
static {
Properties pro = new Properties();
InputStream in = KdniaoTrackQueryAPI.class.getResourceAsStream("/api.properties");
try {
pro.load(in);
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
System.out.println("读取配置文件出错");
}
params.put("EBusinessID", pro.getProperty("EBusinessID"));
params.put("AppKey", pro.getProperty("AppKey"));
}
//电商ID
// private String EBusinessID="";
//电商加密私钥,快递鸟提供,注意保管,不要泄漏
// private String AppKey="";
//请求url
//正式环境
private String ReqURL = "https://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx";
//测试环境
//private String ReqURL = "http://sandboxapi.kdniao.com:8080/kdniaosandbox/gateway/exterfaceInv oke.json";
/**
* Json方式 查询订单物流轨迹
* @throws Exception
*/
public String getOrderTracesByJson(String expCode, String expNo) throws Exception{
String requestData= "{'OrderCode':'','ShipperCode':'" + expCode + "','LogisticCode':'" + expNo + "'}";
String AppKey = params.get("AppKey");
params.put("RequestData", urlEncoder(requestData, "UTF-8"));
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);
//根据公司业务处理返回的信息......
String show = "";
try {
JSONObject obj = JSONObject.parseObject(result);
boolean bool = obj.getBooleanValue("Success");
if (!bool) {
show = "暂时无法查询到该物流轨迹信息。";
} else {
JSONArray arr = obj.getJSONArray("Traces");
for (int i = 0; i < arr.size(); i++) {
JSONObject o = (JSONObject) arr.get(i);
show = show + o.getString("AcceptTime") + "<br/>";
show = show + o.getString("AcceptStation") + "<br/><br/>";
}
}
}catch (Exception e) {
e.printStackTrace();
}
return show;
}
/**
* 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();
}
}