- 前提
- 应用场景
- 可实现需求
- 申请Key
- 快递查询Api接口
- 接口文档及各开发语言Demo
- 查询Api接口定义
-
- 系统级输入参数
- 应用级输入参数
- 返回结果参数
- 请求JSON参数
- 响应JSON参数
-
- 查询Api接口使用
- 温馨提示
前提
项目开发中,有些需求难免会用到关于快递的一些Api接口;本篇主要介绍的是快递的查询Api及与其他各家的不同之处;
常用的提供快递Api接口的有:
- 快递鸟
- 快递100
- 爱查快递
等等
如大家使用过,快递100和爱查快递等等网站提供的快递查询等接口时,你会发现,你所申请的账号或key每天调用Api接口的次数都是被限制的,有的是2000次/天,有的是5000次/次;唯一让你感到麻烦的是,要求用户添加外链,而快递鸟不需要用户添加外链。对于无门户网站的用户,无非就是很苛刻的要求;并且,超出部分需付费才能使用。
快递鸟,请求Api接口是不限制次数的哟,并且永久免费
固然,对于你小小的需求的话,快递100和爱查快递都可满足你的需求;但是,当万一某天请求次数太多,你的查询服务就得停止,影响你的产品体验;所以,推荐你直接使用快递鸟,一步到位。
应用场景
查询订单的物流信息
可实现需求
- App中直接集成实现快递物流信息查询Api接口
- 在微信公众号中,根据用户输入的订单号,我们的后台识别订单号并根据快递鸟查询快递Api接口,实现自动查询的功能
- 等等
申请Key
按照你的信息,依次把信息填写完整,点击提交申请即可。
登录成功后,就可以看到ID和key等信息,有这些信息就可以请求查询等其他的接口Api
快递查询Api接口
接口文档及各开发语言Demo
查询Api接口定义
系统级输入参数
参数名称 | 类型 | 必须要求 | 说明 |
---|---|---|---|
RequestData | String | R | 请求内容,JSON或XML格式,须和DataType一致 |
EBusinessID | String | R | 用户ID |
RequestType | String | R | 请求指令类型:1002 |
DataSign | String | R | 数据内容签名 |
DataType | String | O | 请求、返回数据类型:1-xml,2-json;默认为xml格式 |
应用级输入参数
参数名称 | 类型 | 必须要求 | 说明 |
---|---|---|---|
OrderCode | varchar(50) | O | 订单编号 |
ShipperCode | varchar(10) | R | 快递公司编码 |
LogisticCode | varchar(50) | R | 物流单号 |
返回结果参数
参数名称 | 类型 | 必须要求 | 说明 |
---|---|---|---|
EBusinessID | Int | R | 电商用户ID |
OrderCode | Varchar(50) | O | 订单编号 |
ShipperCode | varchar(10) | R | 快递公司编码 |
LogisticCode | Varchar(50) | R | 物流运单号 |
Success | Bool | R | 成功与否 |
Reason | Varchar(50) | O | 失败原因 |
State | Int | R | 物流状态1:已取件2:在途中3:签收 |
Traces | Varchar(Max) | R | 物流轨迹详情 |
物流轨迹详情
参数名称 | 类型 | 必须要求 | 说明 |
---|---|---|---|
AcceptTime | DateTime | R | 时间 |
AcceptStation | Varchar(50) | R | 描述 |
Remark | Varchar(150) | O | 备注 |
请求JSON参数
{
"OrderCode" : "",
"ShipperCode" : "SF",
"LogisticCode" : "118650888018"
}
响应JSON参数
{
"EBusinessID" : "1109259",
"OrderCode" : "",
"ShipperCode" : "SF",
"LogisticCode" : "118461988807",
"Success" : true,
"State" : 3,
"Reason" : null,
"traces" : [{
"AcceptTime" : "2014/06/25 08:05:37",
"AcceptStation" : "正在派件..(派件人:邓裕富,电话:18718866310)[深圳 市]",
"Remark" : null
}, {
"AcceptTime" : "2014/06/25 04:01:28",
"AcceptStation" : "快件在 深圳集散中心 ,准备送往下一站 深圳 [深圳市]",
"Remark" : null
}, {
"AcceptTime" : "2014/06/25 01:41:06",
"AcceptStation" : "快件在 深圳集散中心 [深圳市]",
"Remark" : null
}, {
"AcceptTime" : "2014/06/24 20:18:58",
"AcceptStation" : "已收件[深圳市]",
"Remark" : null
}, {
"AcceptTime" : "2014/06/24 20:55:28",
"AcceptStation" : "快件在 深圳 ,准备送往下一站 深圳集散中心 [深圳市]",
"Remark" : null
}, {
"AcceptTime" : "2014/06/25 10:23:03",
"AcceptStation" : "派件已签收[深圳市]",
"Remark" : null
}, {
"AcceptTime" : "2014/06/25 10:23:03",
"AcceptStation" : "签收人是:已签收[深圳市]",
"Remark" : null
}
]
}
查询Api接口使用
以Java开发语言为例,进行展开
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;
/**
*
* 快递鸟物流轨迹即时查询接口
*
* @技术QQ群: 456320272
* @see: http://www.kdniao.com/YundanChaxunAPI.aspx
* @copyright: 深圳市快金数据技术服务有限公司
*
* DEMO中的电商ID与私钥仅限测试使用,正式环境请单独注册账号
* 单日超过500单查询量,建议接入我方物流轨迹订阅推送接口
*
* ID和Key请到官网申请:http://www.kdniao.com/ServiceApply.aspx
*/
public class KdniaoTrackQueryAPI {
//DEMO
public static void main(String[] args) {
KdniaoTrackQueryAPI api = new KdniaoTrackQueryAPI();
try {
String result = api.getOrderTracesByJson("ANE", "210001633605");
System.out.print(result);
} catch (Exception e) {
e.printStackTrace();
}
}
//电商ID
private String EBusinessID="请到快递鸟官网申请http://www.kdniao.com/ServiceApply.aspx";
//电商加密私钥,快递鸟提供,注意保管,不要泄漏
private String AppKey="请到快递鸟官网申请http://www.kdniao.com/ServiceApply.aspx";
//请求url
private String ReqURL="http://api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx";
/**
* 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.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();
}
}
其他Api接口,请转到快递鸟具体查看相关文档。
温馨提示
如你的产品需对接或集成快递接口,快递鸟是不错的选择;会给您提供专业的技术支持人员;查询次数不限,并永久免费。
ps:Coolspan kdniao
时间: 2024-10-05 11:17:04