1.接入指南
注册、登录
获取调用凭证
依据接口文档实现业务逻辑
测试说明
功能上线
2.获取调用凭证token
token是全局唯一接口调用凭证,token存在过期时间,过期需要刷新token或重新获取token,获取token方式如下: Token
(1)注册并登录平台,获取第三方用户唯一凭证和凭证密匙,如图:
(2)通过ClientId 和Client Secret 获取接口凭证token:
Token POST http://10.62.163.111:8882/v1/Oauth/token
POST
http://10.62.163.111:8882/v1/Oauth/token
说明: 过期时间7200秒。过期:产生新 token,未达过期时间:回传 token 与剩余到期秒数
请求参数:
类型 | 必填 | 备注 | 范例 | |
---|---|---|---|---|
client_id | string | Y | No1sX01PbbnLw | |
client_secret | string | Y | 2394fb0d9faa24b72902443831667d0d | |
grant_type | string | Y | client_credentials |
请求示例:
{ "client_id": "No1sX01PbbnLw", "client_secret": "2394fb0d9faa24b72902443831667d0d", "grant_type": "client_credentials" }
返回结果:
参数名称 | 类型 | 备注 | 范例 |
---|---|---|---|
code | integer | 0 | |
msg | string | success | |
token | string | 93f3f23557c6c25d76bffead16c82aebbb3d77ee104b507e38919695897a2531 | |
expires_in | integer | 5224 | |
refresh_token | string | 9e5bb4dff226e4d656d3467ca4eb882fe3379d00d5cea77c35c5aabf79d8b56d |
返回示例:
{ "code": 0, "msg": "success", "token": "93f3f23557c6c25d76bffead16c82aebbb3d77ee104b507e38919695897a2531", "expires_in": 5224, "refresh_token": "9e5bb4dff226e4d656d3467ca4eb882fe3379d00d5cea77c35c5aabf79d8b56d" }
3.刷新凭证
重新生成 token POST http://10.62.163.111:8882/v1/Oauth/token
POST
http://10.62.163.111:8882/v1/Oauth/token
说明: 在 token 失效过期前,重新生成 token
请求参数:
参数名称 | 类型 | 必填 | 备注 | 范例 |
---|---|---|---|---|
refresh_token | string | Y | refresh_token | 12943601459cc83edfadddc1d65d258b7f8c9adeadf10 |
grant_type | string | Y | 固定值 refresh_token | refresh_token |
请求示例:
{ "refresh_token": "12943601459cc83edfadddc1d65d258b7f8c9adeadf10", "grant_type": "refresh_token" }
返回结果:
参数名称 | 类型 | 备注 | 范例 |
---|---|---|---|
access_token | string | 验证身份使用 | eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9 |
expires_in | int | 存活秒数 | 7200 |
refresh_token | string | 在 token 失效过期前,重新生成 token | 12943601459cc83edfadddc1d65d258b7f8c9adeadf10 |
返回示例:
{ "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9", "expires_in": "7200", "refresh_token": "12943601459cc83edfadddc1d65d258b7f8c9adeadf10" }
4.验证规范
请求方法:
GET、POST、PUT、PATCH、DELETE。传递内容:
参数键值与内容以 json 字符串格式传递。Request Header:
参数名称 | 类型 | 必填 | 备注 | 范例 |
---|---|---|---|---|
Content-Type | String | Y | application/json | MIME Content Type. |
Authorization | String | Y | Bearer <token> | Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9 |