Skip to content

User API

/user-reg

  • 用途:用户注册
  • 认证:无
  • 输入参数
    参数名类型说明
    usernamestring用户名
    emailstring邮箱
    passstring密码
    codestring验证码
    noncestring验证随机串
    useridstring用户ID(可选)
  • 输出参数
    参数名类型说明
    statusint状态码
    is_send_emailint是否发送验证邮件

/user-email-activate

  • 用途:重新发送激活邮件
  • 认证:无
  • 输入参数
    参数名类型说明
    emailstring邮箱
    codestring验证码
    noncestring验证随机串
  • 输出参数
    参数名类型说明
    statusint状态码

/email-verify-check-token

  • 用途:验证Email激活码是否有效
  • 认证:无
  • 输入参数
    参数名类型说明
    tokenstring激活码
  • 输出参数
    参数名类型说明
    statusint状态码

/user-login

  • 用途:用户登录
  • 认证:无
  • 输入参数
    参数名类型说明
    emailstring邮箱
    passstring密码
    codestring验证码
    noncestring验证随机串
    useridstring用户ID(可选)
  • 输出参数
    参数名类型说明
    statusint状态码
    user_login_infoobject登录信息
    • user_login_info 结构
      参数名类型说明
      uidint用户ID
      usernamestring用户名
      roleidint角色ID
      tokenstring登录token
      skstring会话密钥
      etcstring其他
      colorstring主题色

/user-logout

  • 用途:用户登出
  • 认证:普通用户
  • 输入参数:无
  • 输出参数
    参数名类型说明
    statusint状态码

/modify-password

  • 用途:修改密码
  • 认证:普通用户
  • 输入参数
    参数名类型说明
    old_passstring原密码
    passstring新密码
    codestring验证码
    noncestring验证随机串
    useridstring用户ID(可选)
  • 输出参数
    参数名类型说明
    statusint状态码

/edit-user

  • 用途:编辑用户信息
  • 认证:普通用户
  • 输入参数
    参数名类型说明
    usernamestring用户名
    phonestring手机号
    profilestring个人简介
    theme_colorstring主题色
  • 输出参数
    参数名类型说明
    statusint状态码

/sso-check

  • 用途:检查SSO有效性
  • 认证:无
  • 输入参数
    参数名类型说明
    tokenstring请求Token
    callback_urlstring回调URL
  • 输出参数
    参数名类型说明
    statusint状态码

/sso-login

  • 用途:执行SSO登录
  • 认证:普通用户
  • 输入参数
    参数名类型说明
    useridstring用户ID(可选)
  • 输出参数
    参数名类型说明
    statusint状态码

/search-no-group-user

  • 用途:查找没有组队的个人用户(用于邀请)
  • 认证:队长
  • 输入参数
    参数名类型说明
    kw_unamestring查询关键字
  • 输出参数
    参数名类型说明
    statusint状态码
    resultarray查询结果
    • result 结构
      参数名类型说明
      uidint用户ID
      usernamestring用户名
      avatar_hashstring用户头像Hash
      theme_colorstring用户主题色
      profilestring个人简介

/get-profileInfo

  • 用途:获取个人信息(用于显示个人主页)
  • 认证:普通用户
  • 输入参数:无
  • 输出参数
    参数名类型说明
    statusint状态码
    user_infoobject用户信息
    group_infoobject组队信息
    • user_info 结构
      参数名类型说明
      uidint用户ID
      usernamestring用户名
      emailstring登录邮箱
      phonestring手机号
      roleidint角色ID(0-未激活用户 1-普通用户 2-队员 3-队长 4-出题组STAFF 5-管理员)
      create_timeint64创建时间(时间戳)
      update_timeint64更新时间(时间戳)
      avatar_hashstring用户头像Hash
      theme_colorstring用户主题色
      profilestring个人简介
    • group_info 结构
      参数名类型说明
      gidint组ID
      group_namestring组名
      profilestring队伍简介
      create_timeint64创建时间(时间戳)
      update_timeint64更新时间(时间戳)
      member_listarray队伍中用户列表
      • member_list 内部的结构与user_info一致

/getcaptcha

  • 用途:获取验证码
  • 认证:无
  • 请求方式:GET
  • 输入参数:无
  • 输出参数: Header中会带有 X-Captcha-Nonce,值为验证码随机串。 返回Body是 image/gif 格式的二进制图片。

/send-reset-pass-email

  • 用途:发送重置密码邮件
  • 认证:无
  • 输入参数
    参数名类型说明
    emailstring激活码
    codestring验证码
    noncestring验证随机串
    useridstring用户ID(可选)
  • 输出参数
    参数名类型说明
    statusint状态码

/reset-pass-check-token

  • 用途:重置密码验证Token
  • 认证:无
  • 输入参数
    参数名类型说明
    tokenstring密码重置Token
  • 输出参数
    参数名类型说明
    statusint状态码
    emailstring用户Email

/reset-password

  • 用途:重置密码
  • 认证:无
  • 输入参数
    参数名类型说明
    tokenstring密码重置Token
    passstring新密码
    codestring验证码
    noncestring验证随机串
    useridstring用户ID(可选)
  • 输出参数
    参数名类型说明
    statusint状态码

Released under the MIT License. Powered by VitePress.