同城配送接口授权技术文档
一、同城配送账号授权接口
通过第三方授权获取商家账号授权码(目前仅闪送和货拉拉需通过第三方授权接口进行授权)
1.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
1.2 请求地址
https://order.kuaidi100.com/sameCity/order
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
method | 是 | string | 业务类型(默认:auth) |
key | 是 | string | 授权码,请到快递100页面申请企业版接口获取 |
sign | 是 | string | 32位大写,签名,用于验证身份,按MD5 (param +t+key+ secret)的顺序进行MD5加密,不需要加上“+”号。secret在企业管理后台获取 |
t | 是 | string | 时间戳如:1576123932000 |
param | 是 | param | 由其他字段拼接 |
param数据结构:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
com | 是 | string | 快递公司,一律用小写字母,见参数字典 |
storeId | 是 | string | 授权店铺id |
callbackUrl | 是 | String | 授权后信息的信息回调地址 |
1.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
url | string | 授权链接 |
1.4 提供数据内容
请求参数示例
method = auth
key = *******
sign = 4BBDE07660E5EFF90873642CFAE9A8DD
t = 1470304729724
param = {
"com": "shansong",
"storeId": "100000***111",
"callbackUrl": "http://www.baidu.com"
}
返回结果示例
{
"returnCode": "200",
"result": true,
"message": "提交成功",
"data": {
"url": "http://open.s.bingex.com/auth?response_type=code&client_id=ssTQhMCPkKfdz38Le&state=null&scope=shop_open_api&thirdStoreId=null&redirect_uri=http://api.kuaidi100.com/callback/ss/auth"
}
}
说明:点击链接进入授权,登录对应服务商的账号完成授权;授权成功后会跳转页面,保存好对应的参数,用做下单;
1.5 信息代码含义
信息代码 | 信息内容描述 | 原因及建议处理方式 |
---|---|---|
200 | 成功 | 成功 |
400 | 参数错误等 | 提交数据不完整, 检查提交的格式是否为x-www-form-urlencoded的post格式 |
500 | 服务器错误 | 快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数没有按照文档规定填写等,也会报此错误 |
501 | 重复提交 | 快递100的服务器出理间隙或临时性异常,有时如果因为不按规范提交请求,比如快递公司参数没有按照文档规定填写等,也会报此错误 |
503 | 验证签名失败 | 请检查加密方式,param + t + key+ secret 的顺序进行MD5加密,加密后字符串转大写 |
601 | key已过期 | 没有可用单量,账号需要充值使用 |
二、授权回调接口
授权成功后自动回调授权信息。
2.1 接口格式
提供统一格式的HTTP POST或GET调用接口,并返回统一格式JSON数据。
2.2 请求地址
https://order.kuaidi100.com/sameCity/order
请求参数:
参数名 | 是否必填 | 类型 | 说明 |
---|---|---|---|
param | 是 | string | 参数主体 |
2.3 返回结果
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
result | boolean | 提交结果 | true提交成功,false失败 |
returnCode | string | 返回编码 | |
message | string | 返回报文描述 | |
data | data |
data数据结构
字段 | 类型 | 说明 | 备注 |
---|---|---|---|
partnerId | string | 授权partnerId | |
partnerKey | String | 授权key | |
com | String | 快递公司编码 | |
expireTime | String | 过期时间 |
2.4 提供数据内容
入参例子
{
"returnCode": "200",
"result": true,
"message": "提交成功",
"data": {
"com": "shansong",
"partnerId": "863B2B9A8A934014B39E1B237D2AD7D3",
"expireTime": "2022-03-12 17:16:25"
}
}
要求返回结果
{
"returnCode": "200",
"result": true,
"message": "成功"
}
2.5 推送响应报文及错误码解释
字段名称 | 字段含义 |
---|---|
result | true表示成功,false表示失败。如果提交回调接口的地址失败,30分钟后重新回调,3次仍旧失败的,自动放弃 |
returnCode | 200: 提交成功 500: 服务器错误 其他错误请自行定义 |
message | 返回的提示 |