快递鸟查询Api接口使用(PHP版)
程序员文章站
2024-03-26 13:16:47
...
前提
项目开发中,有些需求难免会用到关于快递的一些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接口使用
以PHP开发语言为例,进行展开
<?php
//电商ID
defined('EBusinessID') or define('EBusinessID', '请到快递鸟官网申请http://kdniao.com/reg');
//电商加密私钥,快递鸟提供,注意保管,不要泄漏
defined('AppKey') or define('AppKey', '请到快递鸟官网申请http://kdniao.com/reg');
//请求url
defined('ReqURL') or define('ReqURL', 'http://api.kdniao.cc/Ebusiness/EbusinessOrderHandle.aspx');
//调用查询物流轨迹
//---------------------------------------------
$logisticResult=getOrderTracesByJson();
echo logisticResult;
//---------------------------------------------
/**
* Json方式 查询订单物流轨迹
*/
function getOrderTracesByJson(){
$requestData= "{'OrderCode':'','ShipperCode':'YTO','LogisticCode':'12345678'}";
$datas = array(
'EBusinessID' => EBusinessID,
'RequestType' => '1002',
'RequestData' => urlencode($requestData) ,
'DataType' => '2',
);
$datas['DataSign'] = encrypt($requestData, AppKey);
$result=sendPost(ReqURL, $datas);
//根据公司业务处理返回的信息......
return $result;
}
/**
* post提交数据
* @param string $url 请求Url
* @param array $datas 提交的数据
* @return url响应返回的html
*/
function sendPost($url, $datas) {
$temps = array();
foreach ($datas as $key => $value) {
$temps[] = sprintf('%s=%s', $key, $value);
}
$post_data = implode('&', $temps);
$url_info = parse_url($url);
if(empty($url_info['port']))
{
$url_info['port']=80;
}
$httpheader = "POST " . $url_info['path'] . " HTTP/1.0\r\n";
$httpheader.= "Host:" . $url_info['host'] . "\r\n";
$httpheader.= "Content-Type:application/x-www-form-urlencoded\r\n";
$httpheader.= "Content-Length:" . strlen($post_data) . "\r\n";
$httpheader.= "Connection:close\r\n\r\n";
$httpheader.= $post_data;
$fd = fsockopen($url_info['host'], $url_info['port']);
fwrite($fd, $httpheader);
$gets = "";
$headerFlag = true;
while (!feof($fd)) {
if (($header = @fgets($fd)) && ($header == "\r\n" || $header == "\n")) {
break;
}
}
while (!feof($fd)) {
$gets.= fread($fd, 128);
}
fclose($fd);
return $gets;
}
/**
* 电商Sign签名生成
* @param data 内容
* @param appkey Appkey
* @return DataSign签名
*/
function encrypt($data, $appkey) {
return urlencode(base64_encode(md5($data.$appkey)));
}
?>
其他Api接口,请转到快递鸟具体查看相关文档。
温馨提示
如你的产品需对接或集成快递接口,快递鸟是不错的选择;会给您提供专业的技术支持人员;查询次数不限,并永久免费。