简体中文
简体中文
English
联系我们
注册
登录
语言
简体中文
简体中文
English
联系我们
登录
注册
返回主站
layout空间导航

用户管理

更新时间:2021-10-19 08:35:40下载pdf

登录获取用户 ID 和登录凭证

接口描述

用户 ID 、access_token可以获取一次,缓存提供下次使用。
access_token作为登录凭证,所有的接口(除登录相关接口)访问时都需要携带。

注意:该接口升级前仅返回 uid,2021年4月27日升级后将会返回 access_token。升级前,其余接口不会对 access_token 进行鉴权校验。

请求地址

action: user.wx-applet.synchronization

params请求参数

参数名称 类型 是否必填 说明
open_id String 填入 cloud 即可
app_schema String 填入 cloud 即可
nick_name String 微信昵称,调用 wx.getUserInfo() 获取
avatar String 微信头像,调用 wx.getUserInfo() 获取

请求示例

{
	action: "user.wx-applet.synchronization",
	params: {
		open_id: "cloud",
		app_schema: "cloud",
		nick_name: "微信昵称",
		avatar: "https://wechat-avatar.cn/YAIOgq83epRy7ZNvLmMUHib16hEaLgrGSxNE1BBMm",
	},
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功(true:成功,false:失败)
msg String 请求失败的信息,成功为空
result Object 返回结果

result 说明

参数名 类型 说明
uid String 涂鸦用户 ID
access_token String 登录 token
refresh_token String 刷新 token

响应示例

{
	"result": {
		"access_token": "344c7bdeb1c23b9eccc5******1edc2b",
		"refresh_token": "3783df62d6bb1fdbbb9******09f4cb4",
		"uid": "ay1582981255622T****"
	},
	"success": true,
	"t": 1582870559516
}

错误码

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

错误码 说明
500 系统错误
1106 权限非法
1109 参数非法

token 刷新

access_token 的失效时间到期后,携带 access_token 访问的接口鉴权会报错:

{
  "code": 1010,
  "msg": "令牌过期",
  "success": false,
  "t": 1618216767536
}

这时需要使用 refresh_token 调用刷新接口,换取新的 access_token 和 refresh_token。

注意:
该接口将在2021/4/27后开放使用。

请求地址

action: user.refreshToken;

params 请求参数

参数名称 类型 是否必填 说明
refresh_token String 刷新 token

请求示例

{
	action: "user.wx-applet.synchronization",
	params: {
		refresh_token: "3783df62d6bb1fdbbb9******09f4cb4",
	},
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功(true:成功,false:失败)
msg String 请求失败的信息,成功为空
result Object 返回结果

result 说明

参数名 类型 说明
uid String 涂鸦用户 ID
access_token String 登录 token
refresh_token String 刷新 token

响应示例

{
  "result": {
    "access_token": "00222a5afbdcd9bccd******a1adb240",
    "refresh_token": "be02a06a259af6bec******56814a737",
    "uid": "ay1582981255622T****"
  },
  "success": true,
  "t": 1618216767736
}

获取用户票据

接口描述

每次进入插件前调用,获取最新的票据信息

请求地址

action: system.userTicket

params请求参数

参数名称 类型 是否必填 说明
uid String 用户 ID

请求示例

{
	access_token: "344c7bdeb1c23b9eccc5******1edc2b",
	action: "system.userTicket",
	params: {
		uid: "xxxxxx",
	},
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功(true:成功,false:失败)
msg String 请求失败的信息,成功为空
result Object 返回结果

result说明

参数名 类型 说明
expire_time Number 过期时间
ticket String 票据

响应示例

{
	"result": {
		expire_time: 300
		ticket: "ST-xxx"
	},
	"success": true,
	"t": 1582870559516
}

错误码

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

错误码 说明
500 系统错误
1106 权限非法
1109 参数非法

查询用户信息

接口描述

查询指定涂鸦用户的详细信息。

请求地址

action: user.infos

params请求参数

参数名 类型 说明 是否必填
uid String 涂鸦用户名

请求示例

{
	"access_token": "344c7bdeb1c23b9eccc5******1edc2b",
	"action": "user.infos",
	"params": {
		"uid": "ay1582981255622TXro6"
	}
}

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功(true:成功,false:失败)
msg String 请求失败的信息,成功为空
result Object 返回结果

result说明

参数名 类型 说明
uid String 涂鸦用户ID

响应示例

{
	"result": {
	"avatar": "https://wx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLZrASXPcUvQm3Tmia6ScRhxqoXo5NEmiac0xibFjuz4ib4bYLDibIwffp4zG6QYiclImib5jSqubTS77JEg/132",
	"create_time": 1582981255,
	"nick_name": "昵称",
	"uid": "ay1582981255622TXro6",
	"update_time": 1582981255,
	"username": "wxa-o1Obc4oAhh_jsGGauRBs63hHpjPQYZJ"
	},
	"success": true,
	"t": 1583136691792
}

错误码

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

错误码 说明
500 系统错误
1106 权限非法
1109 参数非法

用户临时票据换取授权令牌

接口描述

使用临时获取的票据(ticket),换取云开发授权的token令牌。

请求地址

action: user.ticketToken

params请求参数

参数名 类型 说明 是否必填
ticket String 用户临时授权票据
access_id String 云开发授权access_id

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功(true:成功,false:失败)
msg String 请求失败的信息,成功为空
result Object 返回结果

result说明

参数名 类型 说明
uid String 涂鸦用户ID
access_token String 授权访问token
refresh_token String 授权刷新token
expire_time Integer 有效时间,单位秒(s)

请求示例

{
	"access_token": "344c7bdeb1c23b9eccc5******1edc2b",
	"action": "user.ticketToken",
	"params": {
		"ticket": "ST-f1d5107ebf677cb4e1a8924b5ffd94f4idjh7L9G0vv9V9zbnfWL",
	"access_id": "xxxxxxx"
	}
}

响应示例

{
	"result": {
	"access_token": "0aa222f672e286ab076c85e6300d05d4",
	"refresh_token": "1048sads8f934f234dwidur3483dsaa3",
	"expire_time": 7200,
	"uid": "ay1582796080015nkQTp"
	},
	"success": true,
	"t": 1582870559516
}

错误码

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

错误码 说明
500 系统错误
1106 权限非法
1109 参数非法

获取第三方应用信息

接口描述

根据传入指定的 schema 和系统类型获取相应第三方应用的应用名称、应用 Logo、描述等信息。

请求地址

action: user.appInfo

params请求参数

参数名 类型 说明 是否必填
ticket String 用户临时授权票据
access_id String 云开发授权access_id

响应参数

参数名 类型 说明
code Integer 响应码
success Boolean 是否成功(true:成功,false:失败)
msg String 请求失败的信息,成功为空
result Object 返回结果

result说明

参数名 类型 说明
app_name String 应用名称
app_logo String 应用Logo地址
app_description String 应用描述

请求示例

{
	"access_token": "344c7bdeb1c23b9eccc5******1edc2b",
	"action": "user.appInfo"
}

响应示例

{
	"result": {
	"app_name": "微信小程序",
	"app_logo": "https://sso.tuya.com/xxxxx.png",
	"app_description": ""
	},
	"success": true,
	"t": 1582870559516
}

错误码

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

错误码 说明
500 系统错误
1106 权限非法
1109 参数非法