快递100如何获取第三方电商平台账号授权的快递物流接口API案例

原创

快递100API

修改于 2021-05-19 15:50:27

1.6K0

修改于 2021-05-19 15:50:27

文章被收录于专栏：程序员也要懂业务

一、第三方电商平台账号授权

通过第三方授权获取月结账号授权码

1.1 接口格式

提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。

1.2 请求地址

<p>https://poll.kuaidi100.com/printapi/authThird.do</p>

请求参数（header）

名称	类型	默认值
Content-Type	string	application/x-www-form-urlencoded

请求参数（body）

参数名	是否必填	类型	说明
key	是	string	授权码，请<a href="https://api.kuaidi100.com/register/enterprise" target="_blank">申请企业版</a>获取
sign	是	string	32位大写，签名，用于验证身份，按MD5 (param +t+key+ secret)的顺序进行MD5加密，不需要加上“+”号，secret在授权邮件里面有
t	是	string	时间戳如：1576123932000
param	是	param	由其他字段拼接

param数据结构：

参数名	是否必填	类型	说明
net	是	string	请求的第三方平台，淘宝：taobao，菜鸟：cainiao，京东：jdalpha，拼多多：pinduoduoWx
callBackUrl	是	string	授权完后的信息回调地址
partnerId	否	string	已经授权完需要重新获取授权信息

1.3 返回结果

字段	说明	备注
result	提交结果	true提交成功，false失败
returnCode	返回编码
message	返回报文描述
data	数据内容

returnCode=200时，说明系统已经授权完成，data的内容

参数名	是否必填	类型	说明
parterId	是	string	授权parterId
net	是	string	授权net
customerId	否	string	内部参数
partnerKey	是	string	授权partnerKey
createTime	否	string	内部参数
data	否	string	内部参数

returnCode=201时，说明系统未授权需要需要进行第三方授权，data的内容

参数名	是否必填	类型	说明
url	是	string	授权链接

1.4 提供数据内容

returnCode=200时，说明系统已经授权完成：

{  
    "result": true,
     "returnCode": "200",
     "message": "成功",
     "data": {
         "customerId": null,
         "createTime": null,
         "partnerKey": "****", // 面单需要的partnerKey 
         "parterId": "****",   // 面单需要的parterId 
         "data": null,
         "net": "****"         // 面单需要的net 
  }
}

returnCode=201时，说明系统未授权需要进行第三方授权:

{  
    "result": false,
    "returnCode": "201",
    "message": "成功",
    "data": {
        "url": "****"  // 通过返回的URL调转到第三方进行授权登录 
  }
}

1.5 返回信息代码含义

字段名称	字段含义
result	true表示成功，false表示失败。
returnCode	200: 提交成功 201: 授权中 400：参数错误 500: 服务器错误其他错误请自行定义
message	返回的提示

二、第三方授权回调

提交的第三方授权中，通过返回的url进行提交后，系统会根据填入的callBackUrl进行数据回传。

2.1 接口格式

提供统一格式的HTTP POST,并返回统一格式JSON数据。

2.2 请求地址

例如：

<form method="post" name="" action="[callbackUrl]">
    <input type="text" name="param" value="{XXX}" />
</form>

请求参数：

字段	类型	说明	备注
param	param	参数主体

param数据结构：

参数名	是否必填	类型	说明
result	是	Boolean	true：成功，false：失败。
returnCode	是	string	200成功
message	是	string	具体报文内容

message数据结构：

参数名	是否必填	类型	说明
kuaidicom	是	string	快递公司编码
parterId	是	string	授权parterId
partnerKey	否	string	授权partnerKey
partnerName	是	string	授权partnerName
partnerSecret	否	string	授权partnerSecret
code	是	string	快递网点编码
checkMan	是	string	快递小哥编码
net	是	stirng	授权net
customerId	否	string	内部参数
createTime	否	string	内部参数
data	否	string	内部参数

2.3 返回结果

字段	说明	备注
result	提交结果	true提交成功，false失败
returnCode	返回编码
message	返回报文描述

2.4 提供数据内容

{  
    "result": true,
    "returnCode": "200",
    "message": "成功" 
}

2.5 回调响应报文

字段名称	字段含义
result	true表示成功，false表示失败。如果提交回调接口的地址失败，30分钟后重新回调，3次仍旧失败的，自动放弃
returnCode	200: 提交成功 500: 服务器错误其他错误请自行定义
message	返回的提示

其他信息快递100会忽略。

三、菜鸟淘宝网点&面单余额接口

通过菜鸟淘宝账号授权接口提交的第三方授权成功后，通过该接口可以获取到该授权账户对应的绑定网点信息以及账户可用单量。

3.1 接口格式

提供统一格式的HTTP POST,并返回统一格式JSON数据。

3.2 请求地址

http://poll.kuaidi100.com/eorderapi.do

请求参数：

参数名	是否必填	类型	说明
method	是	string	业务类型（默认：getThirdInfo）
key	是	string	授权码，请<a href="https://api.kuaidi100.com/register/enterprise" target="_blank">申请企业版</a>获取
sign	是	string	32位大写，签名，用于验证身份，按MD5 (param +t+key+ secret)的顺序进行MD5加密，不需要加上“+”号secret在授权邮件里面有
t	是	string	时间戳如：1576123932000
param	是	param	由其他字段拼接

param数据结构：

参数名	是否必填	类型	说明
partnerId	是	String	调用菜鸟或淘宝第三方授权接口后获取到的partnerId值
partnerKey	是	string	调用菜鸟或淘宝第三方授权接口后获取到的partnerKey值
net	是	string	菜鸟:cainiao,淘宝:taobao
com	否	string	快递公司编号

3.3 返回结果

字段	类型	说明	备注
result	boolean	提交结果	true提交成功，false失败
status	string	返回编码
message	string	返回报文描述
data	array	返回数据

data数据结构

字段	类型	说明
com	string	快递公司编码
comName	string	快递公司名称
branchAccounts	ArrayBranchAccount	快递公司网点列表

BranchAccount数据结构

字段	类型	说明	备注
branchCode	string	网点编号
branchName	string	网点名称
quantity	long	电子面单余额数量
tbNet	string	网点名称，网点编号	绑定网点时提交参数属性

3.4 提供数据内容

{
    "result": true,
    "message": "成功",
    "status": "200",
    "data": [
        {
            "com": "shentong",
            "comName": "申通",
            "branchAccounts": [
                {
                    "branchCode": "00001",
                    "branchName": "辽宁**市场部一部",
                    "quantity": 268,
		    "tbNet": "辽宁**市场部一部, 00001"
                },
                {
                    "branchCode": "00005",
                    "branchName": "辽宁**市场部七部",
                    "quantity": 18875,
		    "tbNet": "辽宁**市场部七部, 00005"
                }
            ]
        }
    ]
}

3.5 返回信息代码含义

信息代码	信息内容描述	原因及建议处理方式
200	成功	提交成功
201	暂无快递单数量	没有查询到网点单量
400	参数错误	请根据技术文档请求，注意参数类型及是否必填。
500	服务器错误	快递100的服务器出理间隙或临时性异常，有时如果因为不按规范提交请求，比如快递公司参数写错等，也会报此错误
501	重复提交	重复提交了请求
503	验证签名失败	请检查加密方式，param + key + secret 的顺序进行MD5加密，加密后字符串转大写,不用加上“+”号
600	您不是合法的用户（即授权key出错）	快递100账号无可用电子面单单量，需要充值
601	KEY已过期	快递100账号无可用电子面单单量，需要充值