网站开发技术

记点笔记、 学点技术 欢迎交流建站技术。本站关注lamp技术

您尚未登录。

#1 php技术区 » 快宝开放平台物流订阅api接口文档 » 2022-03-24 14:55:52

Lizheng
回复: 0

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

应用场景



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


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

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

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

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

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

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



主要功能



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

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

免费查询:支持日免费查询

性能稳定:日查询过亿,性能稳定

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


接口名称


express.sub.msg

公共参数


请求地址


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

公共请求参数


名称类型是否必须描述
methodstring

API接口名称

app_idstring

用户ID(注册开放平台时分配,在控制台中查看)

signstring

按照规则(md5(app_id + method + ts + api_key))生成的合法性验证签名(32位字符串,字母小写)如:10000cloud.print.do1524209949bdf3b5f50865ac813cbdfd6c9b572b79加密后5030cae3388ecdc2e686379753a0564c

tsstring

当前请求的时间戳(10位或13位)

datastring

JSON格式请求参数

公共响应参数


名称类型是否必须描述
codeint

响应状态码。0-成功,非0-失败下载并查看详情

msgstring

返回结果说明

uidstring

本次请求唯一业务流水号

datastring

JSON格式响应数据

请求参数


名称类型是否必须描述
waybill_codesstring

运单号,多个单号之间用","隔开(英文逗号),最多支持10条

cp_codestring

运单号所属快递品牌,须传简称;申通快递(sto)、中通快递(zt)、圆通速递(ytsd)、极兔速递(jt)、韵达快递(yd)、德邦快递(dbkd)

响应参数


名称类型是否必须描述

No Data

回调参数


名称类型是否必须描述
typestring

回调类型:express_sub_msg

dataarray

物流订阅信息

请求示例


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不支持的快递品牌


#2 php技术区 » 快宝开放平台物流查询api接口文档 » 2022-03-24 14:53:25

Lizheng
回复: 0

API文档/物流跟踪/物流查询

应用场景



1.在电商平台购物后,通过购物订单跟踪物流时,调用此API获取物流信息详情

2.处理运费对账时,一键获取运单物流状态

3.批量跟踪及获取运单物流信息

支持品牌列表下载并查看详情

技术咨询请加微信:kuaibao135


接口名称


express.info.get

公共参数


请求地址


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

公共请求参数


名称类型是否必须描述
methodstring

API接口名称

app_idstring

用户ID(注册开放平台时分配,在控制台中查看)

signstring

按照规则(md5(app_id + method + ts + api_key))生成的合法性验证签名(32位字符串,字母小写)如:10000cloud.print.do1524209949bdf3b5f50865ac813cbdfd6c9b572b79加密后5030cae3388ecdc2e686379753a0564c

tsstring

当前请求的时间戳(10位或13位)

datastring

JSON格式请求参数

公共响应参数


名称类型是否必须描述
codeint

响应状态码。0-成功,非0-失败下载并查看详情

msgstring

返回结果说明

uidstring

本次请求唯一业务流水号

datastring

JSON格式响应数据

请求参数


名称类型是否必须描述
waybill_codesstring

运单号,多个单号之间用","隔开(英文逗号),最多支持10条

cp_codestring

运单号所属快递品牌,需传简称;支持品牌的简称请查看品牌列表下载并查看详情,不传输品牌字段时接口会自动识别品牌后返回结果

result_sortstring

返回的物流信息排序(根据物流时间,0-降序排列,1-升序排列,默认值0)

phonestring

查顺丰快递时,必填。收发件人,手机号码,后4位(如电话号码13900001234,填写1234即可)

响应参数


名称类型是否必须描述
waybill_codestring

运单号

cp_codestring

快递公司品牌;支持品牌列表下载并查看详情

statusstring

物流状态(collected-已揽收;sending-运输中;delivering-派件中;allorgraph-已代收;signed-已签收;question-问题件;)

dataarray

详细物流信息

orderstring

物流轨迹顺序,desc 代表降序排列, asc 代表升序排列

请求示例


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.info.get";// 当前时间戳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":"物流单号多个的以英文逗号分隔", "cp_code":"品牌简称","result_sort":"0"}");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":[

0:{

"waybill_code":

string"3339809700595"

"cp_code":

string"sto"

"status":

string"signed"

"data":[

0:{

"time":

string"2017-10-03 19:11:00"

"context":

string"已签收,签收人是代签"

}

1:{

"time":

string"2017-10-03 08:14:33"

"context":

string"快件已到达 浙江浦江公司"

}

2:{

"time":

string"2017-10-03 01:09:41"

"context":

string"由浙江义乌中转部 发往 浙江浦江公司"

}

]

"order":

string"desc"

}

]

}

异常响应示例


JSON示例

{

"code":

string"错误代码"

"msg":

string"错误信息"

"data":{}

}

错误代码


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


#3 php技术区 » 快宝开放平台智能解析api接口文档 » 2022-03-24 14:50:47

Lizheng
回复: 0

API文档/地址库服务/智能解析

应用场景



1. 电商平台、电商ERP软件、物流应用软件等需要录入联系人信息,允许用户自由输入联系信息,无需分段按规格录入,提升录入效率和使用体验

2. 已有的联系人信息为纯文本,需要自动解析为姓名、电话、省市区、详细地址和备注

3. 用户输入的联系人信息中,省、市、区信息不全或有错误,需要自动纠正为完整、准确的行政区域信息


主要功能



1. 将包含收发件人信息的文本,识别为结构化的收发件人信息,返回姓名、电话号码、省、市、区、乡镇、详细地址、备注等分段信息,能够智能补全地址中缺失的行政区域

2. 对于包含了不规范的行政区域名称、过时的旧称呼、已经撤销或合并的行政区域名称的地址,可以通过该接口解析为规范、最新、准确的行政区域名称


额外说明



技术咨询请加微信:kuaibao135


接口名称


cloud.address.resolve

公共参数


请求地址


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

公共请求参数


名称类型是否必须描述
methodstring

API接口名称

app_idstring

用户ID(注册开放平台时分配,在控制台中查看)

signstring

按照规则(md5(app_id + method + ts + api_key))生成的合法性验证签名(32位字符串,字母小写)如:10000cloud.print.do1524209949bdf3b5f50865ac813cbdfd6c9b572b79加密后5030cae3388ecdc2e686379753a0564c

tsstring

当前请求的时间戳(10位或13位)

datastring

JSON格式请求参数

公共响应参数


名称类型是否必须描述
codeint

响应状态码。0-成功,非0-失败下载并查看详情

msgstring

返回结果说明

uidstring

本次请求唯一业务流水号

datastring

JSON格式响应数据

请求参数


名称类型是否必须描述
multimodebool

是否为批量模式,false为非批量,此时整个text参数认为是一条联系人信息;true为批量,此时根据text参数中的换行符区隔多条联系人信息。默认为true

textstring

包含地址、姓名、电话等信息的待解析文本,批量模式下多条记录用回车或换行符(\r\n)分割

resolveTownint

是否从地址中解析乡镇、街道级别行政区域信息。0:不解析,1:地址中包含有乡镇、街道名称,则解析,否则不解析,2:不管地址中是否包含乡镇、街道名称,都尝试解析乡镇信息。默认值为0。若值为1或2,返回结果中会包含town_name,town_id, town_code字段,address字段中将不再包含乡镇级别行政区域信息

响应参数


名称类型是否必须描述
originalstring

输入的原始文本。响应体的data字段为一数组,每个数组元素为一条解析结果,本节描述的是每个元素的字段

mobilestring

手机号码

phonestring

固定电话

namestring

姓名

notestring

备注

province_namestring

省级名称

province_shortnamestring

省级简称

province_idstring

省级快宝内部ID

province_codestring

省级行政区划代码

city_namestring

市级名称

city_shortnamestring

市级简称

city_idstring

市级快宝内部ID

county_namestring

县级名称

county_shortnamestring

县级简称

county_idstring

县级快宝内部ID

county_codestring

县级行政区划代码

town_namestring

乡镇、街道名称,仅在resolveTown为true时返回该值

town_idstring

乡镇、街道级别快宝内部ID,仅在resolveTown为true时返回该值

town_codestring

乡镇、街道级别行政区划代码

detailstring

详细地址

province_confidenceint

省级信息解析准确度字段,当返回值小于3时认为准确度相对较低有识别错误概率,该字段可用于客户端提示用户检查地址信息时使用;

city_confidenceint

市级信息解析准确度字段,当返回值小于3时认为准确度相对较低有识别错误概率,该字段可用于客户端提示用户检查地址信息时使用;

county_confidenceint

区级信息解析准确度字段,当返回值小于3时认为准确度相对较低有识别错误概率,该字段可用于客户端提示用户检查地址信息时使用;

请求示例

单条请条示例

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 = "cloud.address.resolve";// 当前时间戳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", "{
    "text":"浙江省绍兴市诸暨市浣东街道西子公寓北区电话:13905857430  衣服  食物 ",
    "multimode":false
}");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":[

0:{

"original":

string"浙江省绍兴市诸暨市浣东街道西子公寓北区电话:13905857430 衣服 食物 "

"phone":

string""

"mobile":

string"13905857430"

"name":

string"衣服 食物"

"note":

string""

"province_id":

string"334"

"province_name":

string"浙江省"

"province_shortname":

string"浙江"

"province_code":

string"330000"

"city_id":

string"1304"

"city_name":

string"绍兴市"

"city_shortname":

string"绍兴"

"city_code":

string"330600"

"county_id":

string"1357"

"county_name":

string"诸暨市"

"county_shortname":

string"诸暨"

"county_code":

string"330681"

"detail":

string"西子公寓北区"

"town_id":

string"883331"

"town_name":

string"浣东街道"

"town_code":

string""

}

]

}

异常响应示例


JSON示例

{

"code":

int400001

"msg":

string"业务参数有误,请检查"

"uid":

string"a6934adee62d8ba3430d4ac678dd5f46c7a79d6e"

"data":{}

}

错误代码


错误码描述
300101快递单号创建失败
300102获取快递单号失败
300103不合法的请求参数
300103图片格式错误
300104签名格式不正确
300105请求方式错误
300105请求方式错误
300106请求的的数据格式错误
300107缺少必要参数
300108用户app_id值不正确
300109不存在的业务类型
300110请求含有非法参数
300111请求参数不能为空
300112用户app_key值不正确
300115业务参数有误,请检查
400001业务参数有误
400002超出批量解析最大数量限制
400003输入字符太少
400004请求方式错误
400005请求数据格式错误
400006缺少必要的参数
400007类型不合法
400008不支持的快递品牌


#4 php技术区 » 快宝开放平台地址清洗api接口文档 » 2022-03-24 14:48:35

Lizheng
回复: 0

API文档/地址库服务/智能解析

应用场景



1. 电商平台、电商ERP软件、物流应用软件等需要录入联系人信息,允许用户自由输入联系信息,无需分段按规格录入,提升录入效率和使用体验

2. 已有的联系人信息为纯文本,需要自动解析为姓名、电话、省市区、详细地址和备注

3. 用户输入的联系人信息中,省、市、区信息不全或有错误,需要自动纠正为完整、准确的行政区域信息


主要功能



1. 将包含收发件人信息的文本,识别为结构化的收发件人信息,返回姓名、电话号码、省、市、区、乡镇、详细地址、备注等分段信息,能够智能补全地址中缺失的行政区域

2. 对于包含了不规范的行政区域名称、过时的旧称呼、已经撤销或合并的行政区域名称的地址,可以通过该接口解析为规范、最新、准确的行政区域名称


额外说明



技术咨询请加微信:kuaibao135


接口名称


cloud.address.resolve

公共参数


请求地址


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

公共请求参数


名称类型是否必须描述
methodstring

API接口名称

app_idstring

用户ID(注册开放平台时分配,在控制台中查看)

signstring

按照规则(md5(app_id + method + ts + api_key))生成的合法性验证签名(32位字符串,字母小写)如:10000cloud.print.do1524209949bdf3b5f50865ac813cbdfd6c9b572b79加密后5030cae3388ecdc2e686379753a0564c

tsstring

当前请求的时间戳(10位或13位)

datastring

JSON格式请求参数

公共响应参数


名称类型是否必须描述
codeint

响应状态码。0-成功,非0-失败下载并查看详情

msgstring

返回结果说明

uidstring

本次请求唯一业务流水号

datastring

JSON格式响应数据

请求参数


名称类型是否必须描述
multimodebool

是否为批量模式,false为非批量,此时整个text参数认为是一条联系人信息;true为批量,此时根据text参数中的换行符区隔多条联系人信息。默认为true

textstring

包含地址、姓名、电话等信息的待解析文本,批量模式下多条记录用回车或换行符(\r\n)分割

resolveTownint

是否从地址中解析乡镇、街道级别行政区域信息。0:不解析,1:地址中包含有乡镇、街道名称,则解析,否则不解析,2:不管地址中是否包含乡镇、街道名称,都尝试解析乡镇信息。默认值为0。若值为1或2,返回结果中会包含town_name,town_id, town_code字段,address字段中将不再包含乡镇级别行政区域信息

响应参数


名称类型是否必须描述
originalstring

输入的原始文本。响应体的data字段为一数组,每个数组元素为一条解析结果,本节描述的是每个元素的字段

mobilestring

手机号码

phonestring

固定电话

namestring

姓名

notestring

备注

province_namestring

省级名称

province_shortnamestring

省级简称

province_idstring

省级快宝内部ID

province_codestring

省级行政区划代码

city_namestring

市级名称

city_shortnamestring

市级简称

city_idstring

市级快宝内部ID

county_namestring

县级名称

county_shortnamestring

县级简称

county_idstring

县级快宝内部ID

county_codestring

县级行政区划代码

town_namestring

乡镇、街道名称,仅在resolveTown为true时返回该值

town_idstring

乡镇、街道级别快宝内部ID,仅在resolveTown为true时返回该值

town_codestring

乡镇、街道级别行政区划代码

detailstring

详细地址

province_confidenceint

省级信息解析准确度字段,当返回值小于3时认为准确度相对较低有识别错误概率,该字段可用于客户端提示用户检查地址信息时使用;

city_confidenceint

市级信息解析准确度字段,当返回值小于3时认为准确度相对较低有识别错误概率,该字段可用于客户端提示用户检查地址信息时使用;

county_confidenceint

区级信息解析准确度字段,当返回值小于3时认为准确度相对较低有识别错误概率,该字段可用于客户端提示用户检查地址信息时使用;

请求示例

单条请条示例

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 = "cloud.address.resolve";// 当前时间戳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", "{
    "text":"浙江省绍兴市诸暨市浣东街道西子公寓北区电话:13905857430  衣服  食物 ",
    "multimode":false
}");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":[

0:{

"original":

string"浙江省绍兴市诸暨市浣东街道西子公寓北区电话:13905857430 衣服 食物 "

"phone":

string""

"mobile":

string"13905857430"

"name":

string"衣服 食物"

"note":

string""

"province_id":

string"334"

"province_name":

string"浙江省"

"province_shortname":

string"浙江"

"province_code":

string"330000"

"city_id":

string"1304"

"city_name":

string"绍兴市"

"city_shortname":

string"绍兴"

"city_code":

string"330600"

"county_id":

string"1357"

"county_name":

string"诸暨市"

"county_shortname":

string"诸暨"

"county_code":

string"330681"

"detail":

string"西子公寓北区"

"town_id":

string"883331"

"town_name":

string"浣东街道"

"town_code":

string""

}

]

}

异常响应示例


JSON示例

{

"code":

int400001

"msg":

string"业务参数有误,请检查"

"uid":

string"a6934adee62d8ba3430d4ac678dd5f46c7a79d6e"

"data":{}

}

错误代码


错误码描述
300101快递单号创建失败
300102获取快递单号失败
300103不合法的请求参数
300103图片格式错误
300104签名格式不正确
300105请求方式错误
300105请求方式错误
300106请求的的数据格式错误
300107缺少必要参数
300108用户app_id值不正确
300109不存在的业务类型
300110请求含有非法参数
300111请求参数不能为空
300112用户app_key值不正确
300115业务参数有误,请检查
400001业务参数有误
400002超出批量解析最大数量限制
400003输入字符太少
400004请求方式错误
400005请求数据格式错误
400006缺少必要的参数
400007类型不合法
400008不支持的快递品牌


页脚

Powered by FluxBB