快宝开放平台物流订阅api接口文档

Lizheng · 2022-03-24 14:55:52

API文档/物流跟踪/物流订阅

应用场景

物流订阅接口，可根据开发者提交的运单号，实时监控包裹的物流轨迹，在获取最新物流状态后，快宝网络实时通过回调地址推送给开发者，直到运单号对应包裹完成签收。当前支持订阅的快递品牌均为快递公司总部直接合作，与对应快递官网数据同步更新，现支持订阅快递为：中通快递、申通快递、圆通速递、韵达快递、德邦快递、极兔速递（含百世快递）

1、电商网站对发货包裹进行物流追踪，实时展示最新物流状态给用户

2、物流管理系统，监控所有包裹实时状态，可进行可视化管理

3、涉及物流的相关公众号、小程序、APP，可实时推送物流状态变更信息，增强购买体验，留存客户

4、发货企业可根据接收“已签收”状态，作为订单完结节点及收款依据

5、根据不同快递公司的物流状态变更信息，可预估快递公司时效，合理配置发货快递

6、电商客服可批量跟踪“派件中”、“已签收”、“问题件”等状态的单号，方便跟单及通知收货

主要功能

实时监控：实时监控物流轨迹，监控物流状态变更，获取最新状态后实时推送，直到快递签收

品牌覆盖：支持常用主流快递品牌查询，物流轨迹全面

免费查询：支持日免费查询

性能稳定：日查询过亿，性能稳定

数据安全：三级等保资质，与快递公司直连，安全闭环

接口名称

express.sub.msg

公共参数

请求地址

环境名称	HTTPS请求地址
正式地址	https://kop.kuaidihelp.com/api

公共请求参数

名称	类型	是否必须	描述
method	string	是	API接口名称
app_id	string	是	用户ID（注册开放平台时分配，在控制台中查看）
sign	string	是	按照规则(md5(app_id + method + ts + api_key))生成的合法性验证签名(32位字符串，字母小写)如:10000cloud.print.do1524209949bdf3b5f50865ac813cbdfd6c9b572b79加密后5030cae3388ecdc2e686379753a0564c
ts	string	是	当前请求的时间戳(10位或13位)
data	string	是	JSON格式请求参数

公共响应参数

名称	类型	是否必须	描述
code	int	是	响应状态码。0-成功，非0-失败下载并查看详情
msg	string	是	返回结果说明
uid	string	是	本次请求唯一业务流水号
data	string	是	JSON格式响应数据

请求参数

名称	类型	是否必须	描述
waybill_codes	string	是	运单号，多个单号之间用","隔开（英文逗号），最多支持10条
cp_code	string	是	运单号所属快递品牌，须传简称；申通快递（sto）、中通快递（zt）、圆通速递（ytsd）、极兔速递（jt）、韵达快递（yd）、德邦快递(dbkd)

响应参数

名称

类型

是否必须

描述

No Data

回调参数

名称	类型	是否必须	描述
type	string	是	回调类型：express_sub_msg
data	array	是	物流订阅信息

请求示例

Java

C#

Python

PHP

Node.js

Curl

import java.security.MessageDigest;import java.security.NoSuchAlgorithmException;import java.util.Map;import java.util.HashMap;import java.util.Date;public class Request {public static void main(String[] args) {String host = "http://kop.kuaidihelp.com";String path = "/api";String requestMethod = "POST";
Map<String, String> headers = new HashMap<String, String>();//根据API的要求，定义相对应的Content-Typeheaders.put("Content-Type", "application/x-www-form-urlencoded; charset=UTF-8");
Map<String, String> querys = new HashMap<String, String>();
Map<String, String> bodys = new HashMap<String, String>();String appId = "50001";String method = "express.sub.msg";// 当前时间戳String ts = new Date().getTime() + "";String appKey = "bdf3b5f50865ac813cbdfd6c9b572b79";// 计算签名String signStr = appId + method + ts + appKey;String sign = Request.getMD5(signStr, 32);

bodys.put("app_id", appId);
bodys.put("method", method);
bodys.put("ts", ts);
bodys.put("sign", sign);// data参数是个json格式的字符串  建议使用函数或方法去生成bodys.put("data", "{"waybill_codes":"6387423984","cp_code":"zt"}");try {	/**
	* 重要提示如下:
	* HttpUtils请从
	* https://github.com/aliyun/api-gateway-demo-sign-java/blob/master/src/main/java/com/aliyun/api/gateway/demo/util/HttpUtils.java
	* 下载
	*
	* 相应的依赖请参照
	* https://github.com/aliyun/api-gateway-demo-sign-java/blob/master/pom.xml
	*/
	HttpResponse response = HttpUtils.doPost(host, path, requestMethod, headers, querys, bodys);
	System.out.println(response.toString());	
		//获取response的body
		System.out.println(EntityUtils.toString(response.getEntity()));
	} catch (Exception e) {
		e.printStackTrace();
	}
}	// 计算md5
    public static String getMD5(String plainText, int length) {        try {
            MessageDigest md = MessageDigest.getInstance("MD5");//获取MD5实例
            md.update(plainText.getBytes());//此处传入要加密的byte类型值
            byte[] digest = md.digest();//此处得到的是md5加密后的byte类型值

            /*
               下边的运算就是自己添加的一些二次小加密，记住这个千万不能弄错乱，
                   否则在解密的时候，你会发现值不对的（举例：在注册的时候加密方式是一种，
                在我们登录的时候是不是还需要加密它的密码然后和数据库的进行比对，但是
            最后我们发现，明明密码对啊，就是打不到预期效果，这时候你就要想一下，你是否
             有改动前后的加密方式）   
            */
            int i;
            StringBuilder sb = new StringBuilder();            for (int offset = 0; offset < digest.length; offset++) {
                i = digest[offset];                if (i < 0)
                    i += 256;                if (i < 16)
                    sb.append(0);
                sb.append(Integer.toHexString(i));//通过Integer.toHexString方法把值变为16进制
            }            return sb.toString().substring(0, length);//从下标0开始，length目的是截取多少长度的值
        } catch (NoSuchAlgorithmException e) {
            e.printStackTrace();            return null;
        }
    }
}

响应示例

成功响应示例

JSON示例

{

"code":

int0

"msg":

string"成功"

"data":{}

"uid":

string"6fb93a8325e0318cba62a9e6f7e12a7b00000000"

}

异常响应示例

JSON示例

{

"code":

int1008

"msg":

string"余额不足"

"data":{}

"uid":

string"6fb93a8325e0318cba62a9e6f7e12a7b00000000"

}

错误代码

错误码	描述
201101	查询暂无记录
201102	请求参数错误
201103	不支持的快递品牌

网站开发技术

#1 2022-03-24 14:55:52