授权管理

更新时间:2025-05-30 01:56:03下载pdf

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

开放协议描述

        由于每个业务接口都需进行token鉴权,因此首先调用涂鸦授权中心接口获取access_token和refresh_token,涂鸦授权中心遵循oauth2协议标准,提供了下面获取token的方式。
授权管理

  • 开发者client_id和secret按照涂鸦授权中心接口规范进行签名认证;
  • 涂鸦云校验并颁发令牌给第三方平台。

注:access_token有效时间为2小时,refresh_token长期有效,access_token过期后可使用refresh_token请求涂鸦云刷新令牌,涂鸦云会颁发新的access_token和refresh_token,刷新令牌后旧的access_token和refresh_token将会失效。

授权流程

授权管理

API 列表

请求方式 API 描述
GET /v1.0/token 获取访问令牌。
GET /v1.0/token/{refresh_token} 刷新用户令牌。

获取令牌

接口描述

        通过开发者平台创建云应用对应的授权凭证获取令牌。

接口地址

GET /v1.0/token

请求参数

参数名 类型 参数类型 说明 必填
grant_type Integer URL 授权类型,1:简单模式

响应参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13位
result Object 令牌信息

result 参数说明

参数名 类型 说明
uid String Tuya 用户 ID
access_token String 访问令牌凭证
expire_time Integer 有效时间,单位:s
refresh_token String 刷新令牌

请求示例

GET {url}/v1.0/token?grant_type=1

返回示例

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

刷新令牌

接口描述

        出于安全考虑,当前每个 OAuth token 的有效期为两小时,过期以后需要使用 refresh_token 来换取新的令牌。
说明:access_token 有时间限制,无次数限制;而 refresh_token 无时间限制,但是只能生效一次。

接口地址

GET /v1.0/token/{refresh_token}

请求参数

参数名 类型 参数类型 说明 必填
refresh_token String URI 刷新令牌 Yes

响应参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13位
result Object 令牌信息

result 参数说明

参数名 类型 说明
uid String Tuya 用户 ID
access_token String 访问令牌凭证
expire_time Integer 有效时间,单位:s
refresh_token String 刷新令牌

请求示例

GET {url}/v1.0/token/******

返回示例

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

错误码

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

错误码 说明
500 系统错误
1003 无效的 grant type
1003 无效的 code