快递100快递管家API接口授权有两种方式,一种是通过使用者的手机号授权,生成一个专属的新账号,通过跳转接口跳转到快递管家进行打单,跳转后使用新账号自动完成登录;一种是通过使用者现有的快递100账号授权,授权后仍使用该现有账号登录快递管家进行打单。
第一种是手机号授权接口,第二种是用户登录授权接口,两个接口的目的都是为了获取access_token值再调用业务接口,具体调用说明如下: 【手机号授权接口】 1.接口信息
接口地址 | b.kuaidi100.com/open/oauth/… |
通信协议 | HTTPS |
请求方式 | POST |
字符集 | UTF-8 |
请求Conent-Type | application/x-www-form-urlencoded |
2.请求参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
client_id | String | 是 | 由快递100提供,接入应用的唯一标识 ([快递管家官网API服务],管理中的App Key) |
client_secret | String | 是 | 由快递100提供,接入应用的唯一标识 [(快递管家官网API服务],管理中的App Secret) |
timestamp | long | 是 | 时间戳(自 1970 年 01 月 01 日起到现在的毫秒数), 例: 1502963129794 |
grant_type | String | 是 | 固定为client_credentials |
sign | String | 是 | 签名 |
mobile | String | 是 | 手机号码 |
3.返回参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
access_token | String | 是 | 可用于调用 API 的 access_token,有效1年;access_token 失效前可通过refresh_token刷新延长,刷一次延长1年 |
expires_in | String | 是 | access_token 的有效时长,单位:秒(过期时间:1年) |
refresh_token | String | 是 | 用于延长 access_token 有效时间的刷新令牌 |
openid | String | 是 | 授权用户的openid |
接口源文档地址:www.kuaidi100.com/ecommerce/a… |
【用户登录授权接口】
1.请求地址拼接
拼接用户授权需访问 url ,示例及参数说明如下:
b.kuaidi100.com/open/oauth/…
公共参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
client_id | String | 是 | 由快递100提供,接入应用的唯一标识 (快递管家官[网API服务],管理中的App Key) |
response_type | String | 是 | 返回的令牌类型(固定为 “code”) |
redirect_uri | String | 是 | redirect_uri 指的是应用发起请求时,所传的回调 地址参数,在用户授权后应用会跳转至 redirect_uri。 要求与应用注册时填写的回调地址一致 |
state | Sting | 否 | 维持应用的状态,返回值与传入值一致。 |
timestamp | long | 是 | 时间戳(自1970年01月01日起到现在的毫秒数), 例:1502963129794 |
sign | String | 是 | API输入参数签名结果,签名算法参照【签名说明】 |
2.引导用户登录授权 | |||
引导用户通过浏览器(建议使用360浏览器)访问以上授权 url,将弹出如下授权页面,用户输入账号信息,点击“登录”。 | |||
3.获取 code | |||
用户点击“登录”按钮后,系统将授权码 code 返回到贵方回调URL上,贵方可以获取并使用该 code 去换取 access_token;code 有效期 3分钟,3 分钟后需要重新授权,如下图: | |||
4.换取 access_token | |||
请求方式:POST | |||
Conent-Type:application/x-www-form-urlencoded | |||
请求地址:b.kuaidi100.com/open/oauth/… | |||
4.1 请求参数 | |||
名称 | 类型 | 是否必填 | 描述 |
------------- | ------ | :------- | ------------------------------------------------------------ |
client_id | String | 是 | 由快递100提供,接入应用的唯一标识 ([快递管家官网API服务],管理中的App Key) |
client_secret | String | 是 | 由快递100提供,接入应用的唯一标识 ([快递管家官网API服务],管理中的App Secret) |
grant_type | String | 是 | 授与方式(固定为 “authorization_code”) |
code | String | 是 | 上一步获取的 code值 |
redirect_uri | String | 是 | redirect_uri 指的是应用发起请求时,所传的回调地址 参数,在用户授权后应用会跳转至 redirect_uri。 要求与快递管家API服务页面填写的回调地址一致 |
timestamp | long | 是 | 时间戳(自1970年01月01日起到现在的毫秒数), 例:1502963129794 |
sign | String | 是 | API输入参数签名结果,签名算法参照【签名说明】 |
4.2 返回参数 | |||
名称 | 类型 | 是否必填 | 描述 |
------------- | ------ | -------- | ------------------------------------------------------------ |
access_token | String | 是 | 可用于调用 API 的 access_token,有效1年;access_token 失效前可通过refresh_token刷新延长,刷一次延长1年 |
expires_in | Long | 是 | access_token 的有效时长,单位:秒(过期时间:1年) |
refresh_token | String | 是 | 用于延长 access_token 有效时间的刷新令牌 |
openid | String | 是 | 授权用户的openid |
接口源文档地址:www.kuaidi100.com/ecommerce/a…
以上两种方式获取的access_token值有效期1年,快到期时可重新授权获取新的access_token值,或者调用刷新令牌接口,具体调用说明如下: 【刷新令牌接口】 1.接口信息
请求地址 | b.kuaidi100.com/open/oauth/… |
请求方式 | POST |
Conent-Type | application/x-www-form-urlencoded |
2.请求参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
client_id | String | 是 | 由快递100提供,接入应用的唯一标识 ([快递管家官网API服务],管理中的App Key) |
client_secret | String | 是 | 由快递100提供,接入应用的唯一标识 [(快递管家官网API服务],管理中的App Secret) |
refresh_token | String | 是 | 授权获取的 refresh_token |
timestamp | long | 是 | 时间戳(自 1970 年 01 月 01 日起到现在的毫秒数), 例: 1502963129794 |
grant_type | String | 是 | 固定为refresh_token |
sign | String | 是 | 签名 |
3.返回参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
access_token | String | 是 | 可用于调用 API 的 access_token,有效1年;access_token 失效前可通过refresh_token刷新延长,刷一次延长1年 |
expires_in | String | 是 | access_token 的有效时长,单位:秒(过期时间:1年) |
refresh_token | String | 是 | 用于延长 access_token 有效时间的刷新令牌 |
openid | String | 是 | 授权用户的openid |
接口源文档地址:www.kuaidi100.com/ecommerce/a…