韦尼克 Logo
韦尼克平台
AI Document Platform
⌘K
开发文档API 调试台AI接入助手

Docs Map

文档目录

产品介绍选择接入方式先读企业认证 & API Key 获取方式共用
用户授权(OAuth + PKCE)用户体系与事件回调用户管理 API消息通知 API
首页用户管理 API

用户管理 API

说明 SaaS 子用户的查询、创建与禁用能力,适用于 SaaS 嵌入方案的运营与账户管理场景。

上一页
用户体系与事件回调
下一页
消息通知 API

认证方式

所有接口均使用 Bearer Token 进行认证。

请求 Header 示例:

Authorization: Bearer Yoo-AI.xxxx.xxxxxx
Content-Type: application/json
字段类型必选说明
Authorizationstring是在 SaaS 应用配置中获取的 Bearer Token
Content-Typestring是固定为 application/json

获取用户列表

  • 请求方式:POST
  • 接口地址:https://saas.api.yoo-ai.com/saas/user/list
  • 请求说明:仅需携带 Header,无需请求体

响应示例:

{
  "code": 200,
  "msg": "成功",
  "data": [
    {
      "nickname": "测试用户",
      "mobile": "18688559044",
      "uid": "87hhhrio9",
      "union_id": "QAXTSb6TaW",
      "created_at": "2025-07-05 16:46:00"
    }
  ],
  "request_id": "YOO-saas-api686b77008d63b"
}

创建用户

  • 请求方式:POST
  • 接口地址:https://saas.api.yoo-ai.com/saas/user/create

请求参数:

字段类型必选说明
uidstring是用户唯一标识,最大长度 32
nicknamestring是用户昵称,最大长度 16
mobilestring是用户手机号

成功响应示例:

{
  "code": 200,
  "msg": "创建成功",
  "data": {
    "union_id": "YK6tR4mpp5",
    "uid": "10086"
  },
  "request_id": "YOO-saas-api689318b54e796"
}

用户已存在响应示例:

{
  "code": 2008,
  "msg": "用户已存在...",
  "data": {},
  "request_id": "YOO-saas-api68931ade2410d"
}

禁用用户

  • 请求方式:POST
  • 接口地址:https://saas.api.yoo-ai.com/saas/user/ban

请求参数:

字段类型必选说明
union_idstring是用户创建时返回的 union_id

响应示例:

{
  "code": 200,
  "msg": "处理成功",
  "data": [],
  "request_id": "YOO-saas-api686b76ba45139"
}

接入建议

  • 建议将业务系统中的主用户标识与 uid 保持稳定映射
  • 建议在创建成功后持久化保存 union_id,用于后续禁用和用户关联
  • 对于“用户已存在”场景,建议优先转为查询或复用已存在账户,而不是反复创建

常见错误码

错误码描述建议处理方式
2008用户已存在更换 uid 或查询现有用户
1815未授权或 Token 错误检查 Authorization Header
500服务内部错误保留请求日志并联系技术支持