User API
/user-reg
- 用途:用户注册
- 认证:无
- 输入参数:
参数名 类型 说明 username string 用户名 email string 邮箱 pass string 密码 code string 验证码 nonce string 验证随机串 userid string 用户ID(可选) - 输出参数:
参数名 类型 说明 status int 状态码 is_send_email int 是否发送验证邮件
/user-email-activate
- 用途:重新发送激活邮件
- 认证:无
- 输入参数:
参数名 类型 说明 email string 邮箱 code string 验证码 nonce string 验证随机串 - 输出参数:
参数名 类型 说明 status int 状态码
/email-verify-check-token
- 用途:验证Email激活码是否有效
- 认证:无
- 输入参数:
参数名 类型 说明 token string 激活码 - 输出参数:
参数名 类型 说明 status int 状态码
/user-login
- 用途:用户登录
- 认证:无
- 输入参数:
参数名 类型 说明 email string 邮箱 pass string 密码 code string 验证码 nonce string 验证随机串 userid string 用户ID(可选) - 输出参数:
参数名 类型 说明 status int 状态码 user_login_info object 登录信息 user_login_info
结构参数名 类型 说明 uid int 用户ID username string 用户名 roleid int 角色ID token string 登录token sk string 会话密钥 etc string 其他 color string 主题色
/user-logout
- 用途:用户登出
- 认证:普通用户
- 输入参数:无
- 输出参数:
参数名 类型 说明 status int 状态码
/modify-password
- 用途:修改密码
- 认证:普通用户
- 输入参数:
参数名 类型 说明 old_pass string 原密码 pass string 新密码 code string 验证码 nonce string 验证随机串 userid string 用户ID(可选) - 输出参数:
参数名 类型 说明 status int 状态码
/edit-user
- 用途:编辑用户信息
- 认证:普通用户
- 输入参数:
参数名 类型 说明 username string 用户名 phone string 手机号 profile string 个人简介 theme_color string 主题色 - 输出参数:
参数名 类型 说明 status int 状态码
/sso-check
- 用途:检查SSO有效性
- 认证:无
- 输入参数:
参数名 类型 说明 token string 请求Token callback_url string 回调URL - 输出参数:
参数名 类型 说明 status int 状态码
/sso-login
- 用途:执行SSO登录
- 认证:普通用户
- 输入参数:
参数名 类型 说明 userid string 用户ID(可选) - 输出参数:
参数名 类型 说明 status int 状态码
/search-no-group-user
- 用途:查找没有组队的个人用户(用于邀请)
- 认证:队长
- 输入参数:
参数名 类型 说明 kw_uname string 查询关键字 - 输出参数:
参数名 类型 说明 status int 状态码 result array 查询结果 result
结构参数名 类型 说明 uid int 用户ID username string 用户名 avatar_hash string 用户头像Hash theme_color string 用户主题色 profile string 个人简介
/get-profileInfo
- 用途:获取个人信息(用于显示个人主页)
- 认证:普通用户
- 输入参数:无
- 输出参数:
参数名 类型 说明 status int 状态码 user_info object 用户信息 group_info object 组队信息 user_info
结构参数名 类型 说明 uid int 用户ID username string 用户名 email string 登录邮箱 phone string 手机号 roleid int 角色ID(0-未激活用户 1-普通用户 2-队员 3-队长 4-出题组STAFF 5-管理员) create_time int64 创建时间(时间戳) update_time int64 更新时间(时间戳) avatar_hash string 用户头像Hash theme_color string 用户主题色 profile string 个人简介 group_info
结构参数名 类型 说明 gid int 组ID group_name string 组名 profile string 队伍简介 create_time int64 创建时间(时间戳) update_time int64 更新时间(时间戳) member_list array 队伍中用户列表 member_list
内部的结构与user_info
一致
/getcaptcha
- 用途:获取验证码
- 认证:无
- 请求方式:GET
- 输入参数:无
- 输出参数: Header中会带有
X-Captcha-Nonce
,值为验证码随机串。 返回Body是image/gif
格式的二进制图片。
/send-reset-pass-email
- 用途:发送重置密码邮件
- 认证:无
- 输入参数:
参数名 类型 说明 email string 激活码 code string 验证码 nonce string 验证随机串 userid string 用户ID(可选) - 输出参数:
参数名 类型 说明 status int 状态码
/reset-pass-check-token
- 用途:重置密码验证Token
- 认证:无
- 输入参数:
参数名 类型 说明 token string 密码重置Token - 输出参数:
参数名 类型 说明 status int 状态码 email string 用户Email
/reset-password
- 用途:重置密码
- 认证:无
- 输入参数:
参数名 类型 说明 token string 密码重置Token pass string 新密码 code string 验证码 nonce string 验证随机串 userid string 用户ID(可选) - 输出参数:
参数名 类型 说明 status int 状态码