通过寄件信息、收件信息,查询快递公司该线路是否支持寄送,减少退回、发货失败等情况,提升用户体验,减少物流成本。
请求地址 GET
https://api.itapi.cn/api/kuaidi/stop
请求参数
参数名 | 参数说明 |
---|---|
key | 用户请求密钥,可在 密钥管理页面 申请 |
address | 湖南省长沙市开福区 |
请求结果参数说明
参数名 | 参数说明 |
---|---|
com | 快递公司简称 |
status | 状态:0 不可达,1 可达 |
reason | 原因 |
返回数据参考
{
"code":200,
"msg":"请求成功",
"data":{
"address":"湖南省常德市武陵区屈原公园",
"0":{
"com":"yuantong",
"status":0,
"reason":"目的网点停派,原因:{疫情管控}"
},
"1":{
"com":"shentong",
"status":0,
"reason":"物流服务不支持派送,疫情 [157684|1]"
},
"2":{
"com":"zhongtong",
"status":0,
"reason":"网点停发"
},
"3":{
"com":"yunda",
"status":0,
"reason":"物流服务不支持派送,疫情管控"
},
"4":{
"com":"jtexpress",
"status":0,
"reason":"疫情管控"
},
"5":{
"com":"debangkuaidi",
"status":0,
"reason":"筛单失败!尊敬的客户您好,该寄递区域受疫情或者交通管制影响,暂停寄递服务,给您带来的不便敬请谅解!"
},
"6":{
"com":"jd",
"status":0,
"reason":null
},
"7":{
"com":"shunfeng",
"status":0,
"reason":"1:尊敬的客户,您好!受目的地疫情影响,暂时无法提供寄递服务,带来不便请您理解。(BPS5600)"
},
"8":{
"com":"youzhengguonei",
"status":0,
"reason":"B99:因疫情防控需要,暂停上述路向快包和生鲜特快邮件。(443)"
}
},
"debug":"",
"exec_time":0.050037,
"user_ip":"183.28.7.144"
}
开发工具 的参数填写,或者直接复制开发工具下面的测试代码。
'key' => $API_KEY,
'address' => '广东省佛山市南海区里水镇甘河路地税局旁滨江东路8号',
);
//签名校验的 SK:(在用户控制台密钥管理的秘钥安全设置->签名校验 开启后才会生效,没开启签名校验留空即可。)
$sk = '72d56eb790ea146ec9a5edaeadad56c2';
/*发起请求API接口:
第1个参数:API接口地址URL,跟上面的同名变量相对应,无需更改。
第2个参数:API接口参数数组,跟上面的同名变量相对应,无需更改。
第3个参数:请求协议(GET或POST),一般默认GET,部分接口需要POST请求,根据实际情况修改为POST即可。
第4个参数:是否验证签名,true验证签名,否则false不验证签名,根据用户控制台 密钥管理 的 秘钥安全设置->签名校验 开启后才会生效,如没开启,填写fasle即可。
第5个参数:如果第4个参数开启验证签名,此处必须填写 SK ,跟上面的同名变量相对应,无需更改。
*/
$resdata = api::send($API_URL, $get_post_data, '选方法', true, $sk); //发起请求,注意这里要选择接口支持的协议,默认GET,可选POST
//打印请求结果
print($resdata);
///你的业务代码可写在这里处理API返回的数据
/**
* API请求类
*/
class api
{
public static function send($API_URL, $get_post_data, $type, $ifsign, $sk)
{
$get_post_data = http_build_query($get_post_data);
if ($ifsign) {
$sign = md5($get_post_data . $sk);
$res = self::send_curl($API_URL, $type, $get_post_data, $sign);
} else {
$res = self::send_curl($API_URL, $type, $get_post_data, null);
}
return $res;
}
//封装好的CURL请求函数,支持POST|GET
public static function send_curl($API_URL, $type, $get_post_data, $sign)
{
$ch = curl_init();
if ($type == 'POST') {
curl_setopt($ch, CURLOPT_URL, $API_URL);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $get_post_data);
} elseif ($type == 'GET') {
curl_setopt($ch, CURLOPT_URL, $API_URL . '?' . $get_post_data);
}
if ($sign) {
curl_setopt($ch, CURLOPT_HTTPHEADER, ['sign:' . $sign]);
}
curl_setopt($ch, CURLOPT_REFERER, $API_URL);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
$resdata = curl_exec($ch);
curl_close($ch);
return $resdata;
}
}
//jQuery-Ajax
$.ajax({
url: 'https://api.itapi.cn/api/kuaidi/stop',
data: {
key: 'VnVLc6XSV8VCCDVbIbxODwLCrw',
address : '广东省佛山市南海区里水镇甘河路地税局旁滨江东路8号',
},
type: '选方法',
dataType: 'json',
success: function(data) {
console.log(data); //输出结果到控制台
},
timeout: 3000, //超时时间
error: function(data) {
console.log('请求失败');
}
});