授权管理

本文介绍如何获取授权管理相关的接口。

API 列表

请求方式	API	描述
GET	/v1.0/token	获取访问令牌
GET	/v1.0/token/{refresh_token}	刷新用户令牌
POST	/v1.0/users/{uid}/ticket	获取免登录令牌

获取令牌

接口描述

通过在开发者平台创建云应用对应的授权密钥，获取令牌。可以通过简单模式和授权模式两种方式获取 Token。关于两个模式的区别，参考 授权模式。

接口地址

GET /v1.0/token

请求参数

参数名	类型	参数类型	必填	说明
grant_type	Integer	URL	是	授权类型。 1：简单模式 3：授权模式
code	String	URL	否	授权码。当 grant_type 取值为 3 时，此参数必填。更多信息，参考 授权模式。
associate_id	String	URL	否	授权关系。当 grant_type 取值为 3 时，此参数必填。更多信息，参考 授权模式。

响应参数

参数名	类型	说明
code	Integer	响应码，参考 错误码
success	Boolean	判断请求是否成功 true：成功 false：失败
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":"eu*****",
      "access_token": "",
      "expire_time": 7200,
      "refresh_token": ""
  }
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见 全局错误码。

错误码	说明
500	系统错误
1003	无效的 grant_type
1107	无效的 code

刷新令牌

接口描述

出于安全考虑，当前每个 OAuth Token 的有效期为两小时。过期以后，需要使用 refresh_token 来换取新的令牌。

接口地址

GET /v1.0/token/{refresh_token}

请求示例

GET /v1.0/token/xxxxxx

返回示例

{
  "success":true,
  "result": {
      "uid":"eu*****",
      "access_token": "",
      "expire_time": 7200,
      "refresh_token": ""
  }
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见 全局错误码。

错误码	说明
500	系统错误
1003	无效的 grant_type
1107	无效的 code

获取免登录令牌

接口描述

根据涂鸦用户 ID（UID），生成免登录令牌。部分场景或者 API 接口需要使用此令牌进行请求。

接口地址

POST /v1.0/users/{uid}/ticket

请求参数

参数名	类型	参数类型	必填	说明
uid	String	URI	是	涂鸦用户 ID（UID）

请求示例

POST /v1.0/users/ay1541161424063Aj***/ticket

响应参数

参数名	类型	说明
code	Integer	响应码，参考 错误码
success	Boolean	判断请求是否成功 true：成功 false：失败
msg	String	请求失败返回的信息，成功则返回空值
result	Object	令牌信息

返回示例

{
    "success":true,
    "result":{
        "ticket":"e0dcadc407806d0360a4df9f5b9f7***",
        "expire_time":300
    }
}

错误码

错误码	说明
500	系统错误