- 9
- 0
- 约1.72万字
- 约 9页
- 2017-06-13 发布于河南
- 举报
AAPCode URL支持的快递公司及参数说明
API名称
带验证码API(APICode URL)
更新日期
2012.8.1
1.APICode URL支持的快递公司及参数说明
分类
快递公司代码
公司名称
E
ems
EMS
S
shentong
伸-通
shunfeng
顺丰
Y
youzhengguonei
中国邮政国内包裹/挂号信
其他快递公司请直接使用 HYPERLINK /p/kuaidi-api/wiki/Open_API_API_URL Open_API_API_URL
2.利用APICode URL创建快递查询程序的整体步骤
第一步
程序利用 APICode URL 获得验证码图片,显示出来。同时,程序获取响应头Response Headers中Set-Cookie的值,将Set-Cookie中的JSESSIONID的值取出。(详见后面《3.APICode URL使用说明》
第二步
用户输入图片中的验证码,并提交
第三步
程序构建一个http请求头,将第一步中获得的JESSIONID的值赋给Cookie,然后将快递公司编码、运单号、验证码值等参数传进 API URL ,提求请求即可获得结果,最后显示出来(详见后面《4.API URL使用说明》)
3.APICode URL使用说明
3.1 作用
部分快递公司在查询时需要输入验证码,可用此API获得验证码图片和cookie等值,为查询运单信息的下一步骤作准备。
3.2 API地址
HYPERLINK /verifyCode?id=%5b%5dcom=%5b /verifyCode?id=[]com=[]
3.3 输入参数说明
名称
类型
是否必需
描述
id
String
是
身份授权key,请点 HYPERLINK /openapi 快递查询API 进行申请,此key和API URL的Key是通用的(大小敏感)
com
String
是
要查询的快递公司代码,参考《1.APICode URL所支持的快递公司及参数说明》(大小不敏感)
3.4 返回结果说明
返回一张验证码图片(图片的数据),如果所调用公司查询无需验证码,则无返回数据。
3.5 获取JSESSIONID的方法
(详见后面《5.2开发示范》,下载包中有详细介绍的文档)
4.API URL使用说明
4.1 作用
查询并获得指定快递公司、快递单号的快递信息。
4.2 API地址
HYPERLINK /api?id=%5b%5dcom=%5b%5dnu=%5b%5dvalicode=%5b%5dshow=%5b0%7C1%7C2%7C3%5dmuti=%5b0%7C1%5dorder=%5bdesc%7Casc /api?id=[]com=[]nu=[]valicode=[]show=[0|1|2|3]muti=[0|1]order=[desc|asc]
4.3 输入参数说明
名称
类型
是否必需
描述
id
String
是
身份授权Key,请到 HYPERLINK /openapi 快递查询API 进行申请(大小敏感)
com
String
是
要查询的快递公司代码,不支持中文,需要和APICode URL配合的公司见《1.APICode URL所支持的快递公司及参数说明》,不需要的见 HYPERLINK /p/kuaidi-api/wiki/Open_API_API_URL Open_API_API_URL 第7章的《API URL 所支持的快递公司及参数说明》 。如果找不到您所需的公司,请发邮件至 kuaidi@kingdee 咨询(大小不敏感)
nu
String
是
要查询的快递单号,请勿带特殊符号,不支持中文(大小不敏感)
valicode
String
否
有两种意义:1、用户输入的验证码,不在《1.APICode URL所支持的快递公司及参数说明》之列的公司请忽略; 2、如果是佳吉物流公司,则要用此参数传入电话号码,其他公司请忽略
show
String
否
返回类型。0:返回json字符串,1:返回xml对象,2:返回html对象,3:返回text文本。如果不填,默认返回json字符串
muti
Stirng
是
返回信息数量。1:返回多行完整的信息,0:只返回一行信息。不填默认返回多行
order
Stirng
否
排序。desc:按时间由新到旧排列,asc:按时间由旧到新排列。不填默认返回倒序(大小不敏感)
4.4 传JESSIONID值的方法
API使用用户必须保证获取验证码的请求与当次查询请求在同一个会话(session)中进行。具体的保持会话,即传JESSIONID的方法,见后面《5.2开发示范》,下载包中有详细介绍的文档。
错误使用场景
API用户始终使用
原创力文档

文档评论(0)