更新时间:2021-09-18 08:54:28下载pdf
本文介绍获取授权管理相关的接口。
请求方式 | API | 描述 |
---|---|---|
GET | /v1.0/token | 获取访问令牌。 |
GET | /v1.0/token/{refresh_token} | 刷新用户令牌。 |
POST | /v1.0/users/{uid}/ticket | 免登录令牌。 |
通过开发者平台创建云应用对应的授权凭证获取令牌。
GET /v1.0/token
参数名 | 类型 | 参数类型 | 必填 | 说明 |
---|---|---|---|---|
grant_type | Integer | URL | 是 | 授权类型,1:简单模式。 |
参数名 | 类型 | 说明 |
---|---|---|
code | Integer | 响应码,详见 错误码。 |
success | Boolean | 判断请求是否成功。
|
msg | String | 请求失败返回的信息,成功则返回空值。 |
result | Object<result> | 令牌信息。 |
result 说明
参数名 | 类型 | 说明 |
---|---|---|
uid | String | 涂鸦用户 ID。 |
access_token | String | 访问令牌。 |
refresh_token | String | 刷新令牌。 |
expire | Integer | 有效时间,单位:秒。 |
GET /v1.0/token?grant_type=1
{
"success":true,
"result": {
"uid":"euxxxxxxxxx",
"access_token": "",
"expire_time": 7200,
"refresh_token": ""
}
}
以下为该接口常见的业务异常,更多的异常错误,请参见 全局错误码。
错误码 | 说明 |
---|---|
500 | 系统错误 |
1003 | 无效的 grant type |
1107 | 无效的 code |
出于安全考虑,当前每个 OAuth token 的有效期为两小时,过期以后需要使用 refresh_token 来换取新的令牌。
说明:access_token 有时间限制,无次数限制;而 refresh_token 无时间限制,但是只能生效一次。
GET /v1.0/token/{refresh_token}
GET /v1.0/token/xxxxxx
{
"success":true,
"result": {
"uid":"euxxxxxxxxx",
"access_token": "",
"expire_time": 7200,
"refresh_token": ""
}
}
以下为该接口常见的业务异常,更多的异常错误,请参见 全局错误码。
错误码 | 说明 |
---|---|
500 | 系统错误 |
1003 | 无效的 grant type |
1107 | 无效的 code |
根据涂鸦用户uid生成免登录令牌,部分场景或者API接口需要使用此令牌进行请求。
POST /v1.0/users/{uid}/ticket
参数名 | 类型 | 参数类型 | 必填 | 说明 |
---|---|---|---|---|
uid | String | URI | 是 | 涂鸦用户 uid |
POST /v1.0/users/ay1541161424063AjySj/ticket
参数名 | 类型 | 说明 |
---|---|---|
code | Integer | 响应码,详见 错误码 。 |
success | Boolean | 判断请求是否成功。
|
msg | String | 请求失败返回的信息,成功则返回空值。 |
result | Object | 令牌信息。 |
{
"success":true,
"result":{
"ticket":"e0dcadc407806d0360a4df9f5b9f7942",
"expire_time":300
}
}
错误码 | 说明 |
---|---|
500 | 系统错误 |
该内容对您有帮助吗?
是意见反馈该内容对您有帮助吗?
是意见反馈