Appearance
📋 SaaS 用户管理指南(API 接入)
本指南适用于使用 YOO-AI SaaS 服务的集成方,如何通过 API 实现用户列表查询、用户添加、用户禁用等基础用户管理操作。
📘 认证方式
所有接口均采用 Bearer Token 方式进行身份验证。
请求 Header 示例:
bash
Authorization: Bearer Yoo-AI.xxxx.xxxxxx
Content-Type: application/json
- Hearder
字段 | 类型 | 必选 | 说明 | 输入示例 |
---|---|---|---|---|
Authorization | string | Y | 在对应的saas应用,配置信息中获取 | Bearer Yoo-xxxxxxxxx |
👥 接口功能说明
✅ 获取用户列表
获取当前 SaaS 应用下所有用户信息。
请求方式:
POST
请求说明: 仅需携带 Header,无需请求体
响应示例
json
{
"code": 200,
"msg": "成功",
"data": [
{
"nickname": "测试用户",
"mobile": "18688559044",
"uid": "87hhhrio9",
"union_id": "QAXTSb6TaW",
"created_at": "2025-07-05 16:46:00"
},
{
"nickname": "测试用户",
"mobile": "139780977",
"uid": "27hhhrio9",
"union_id": "vB7HqJdPYA",
"created_at": "2025-07-07 15:22:28"
}
],
"request_id": "YOO-saas-api686b77008d63b"
}
➕ 添加 SaaS 用户
在当前 SaaS 应用下创建一个新用户。
- 请求方式:
POST
- 接口地址:https://saas.api.yoo-ai.com/saas/user/create
请求参数(Body)
字段 | 类型 | 必选 | 说明 |
---|---|---|---|
uid | string | Y | 用户唯一标识(最大长度 32) |
nickname | string | Y | 用户昵称(最大长度 16) |
mobile | string | Y | 用户手机号 |
响应示例
✅ 成功响应
json
{
"code": 200,
"msg": "创建成功",
"data": {
"union_id": "YK6tR4mpp5",
"uid": "10086"
},
"request_id": "YOO-saas-api689318b54e796"
}
⚠️ 用户已存在
json
{
"code": 2008,
"msg": "用户已存在...",
"data": {},
"request_id": "YOO-saas-api68931ade2410d"
}
⛔ 禁用 SaaS 用户
禁用当前 SaaS 应用下指定的某个用户。
- 请求方式:
POST
- 接口地址:https://saas.api.yoo-ai.com/saas/user/ban
请求参数(Body)
字段 | 类型 | 必选 | 说明 |
---|---|---|---|
union_id | string | Y | 用户创建时接口返回的union_id |
响应示例
json
{
"code": 200,
"msg": "处理成功",
"data": [],
"request_id": "YOO-saas-api686b76ba45139"
}
错误码说明
错误码 | 描述 | 建议处理方式 |
---|---|---|
2008 | 用户已存在 | 更换 uid 或查询用户 |
1815 | 未授权或 Token 错误 | 检查 Authorization 头部 |
500 | 服务内部错误 | 联系平台技术支持 |