账号相关

< Back

目录

• 登录注册
  • 通过手机登录注册发送验证码
  • 通过手机登录注册
  • 手机登录发送验证码
  • 手机验证码登录
  • 密码登录
  • 注册验证发送
  • 注册
  • 登录并刷新 token
• 账户信息
  • 获取账户信息
  • 修改账户信息
• 密码重置与修改
  • 重置密码前发送验证码
  • 重置密码前身份验证
  • 找回密码
  • 修改密码

登录注册

通过手机登录注册发送验证码

POST /account/signinup/code

无需权限验证，参数：

• mobile, 字符串，手机号码

返回成功或失败

错误码：

• 1010 刚刚发送，请用户稍后再试
• 1011 触发频次限制

:up:

通过手机登录注册

POST /account/signinup

无需权限验证，参数：

• mobile, 字符串，手机号码
• code, 字符串，验证码

返回：

{
  "info": AccountEntity,
  "is_new": true,
  "token": "eyJzdWIiOjMsImlzcyI6Imh0dHA6Ly96aGV"
}

• info, 用户信息
• is_new, 布尔值，是否是新注册用户
• token, 字符串，认证令牌

:up:

手机登录发送验证码

POST /account/login/mobile/code

无需权限验证，参数：

• mobile, 字符串，手机号码

返回成功或失败

:up:

手机验证码登录

POST /account/login/mobile

无需权限验证，参数：

• mobile, 字符串，手机号码
• code, 字符串，短信验证码

返回：

{
  "info": AccountEntity,
  "token": "eyJzdWIiOjMsImlzcyI6Imh0dHA6Ly96aGV"
}

• info, 用户信息
• token, 字符串，认证令牌

错误码：

• 1102 用户未注册
• 1105 手机与验证码不匹配

:up:

密码登录

POST /account/login/password

无需权限验证，参数：

• name, 字符串，邮箱/手机号/用户名
• password, 处理过的密码字符串，用户密码

返回：

{
  "info": AccountEntity,
  "token": "eyJzdWIiOjMsImlzcyI6Imh0dHA6Ly96aGV"
}

• info, 用户信息
• token, 字符串，认证令牌

错误码：

• 1102 用户未注册
• 1104 账号与密码不匹配

:up:

注册验证发送

POST /account/register/code

无需权限验证，参数：

• mobile, 字符串，手机号码
• email, 字符串，注册邮箱

手机号、邮箱有一个即可。

返回成功或失败

错误码：

• 1103 用户已注册

:up:

注册

POST /account/register

无需权限验证，参数：

• mobile, 字符串，手机号码
• email, 字符串，注册邮箱
• code, 字符串，短信验证码
• password, 处理过的密码字符串，密码，长度至少 8 位
• name, 字符串，昵称
• sex, 整型 0-2，0 男，1 女，2 保密

手机号、邮箱有一个即可。

返回：

{
  "info": AccountEntity,
  "is_new": true,
  "token": "eyJzdWIiOjMsImlzcyI6Imh0dHA6Ly96aGV"
}

• info, 用户信息
• is_new, 布尔值，是否是新注册用户
• token, 字符串，认证令牌

错误码：

• 1103 用户已注册

:up:

登录并刷新 token

POST /account/login/token

供已登入用户每次启动 app 时延长 token 的有效期

无参数

返回用户信息

:up:

账户信息

获取账户信息

GET /account/info

无参数

返回用户信息

:up:

修改账户信息

PATCH /account/info

参数：

• 其他 Entity#AccountEntity 中的字段，均为可选

返回修改后的用户信息

:up:

密码重置与修改

重置密码前发送验证码

POST /account/otac/send

无需权限验证，参数：

• mobile, 字符串，手机号码
• email, 字符串，注册邮箱

手机号、邮箱有一个即可。

返回成功或失败

错误码：

• 1010 刚刚发送，请用户稍后再试
• 1011 触发频次限制

:up:

重置密码前身份验证

POST /account/otac/verify

无需权限验证，参数：

• mobile, 字符串，手机号码
• email, 字符串，注册邮箱
• code, 字符串，验证码

手机号、邮箱有一个即可。

返回：

{
  "ot_token": "eyJzdWIiOjMsImlzcyI6Imh0dHA6Ly96aGV"
}

• oc_token, 字符串，一次使用的验证令牌（One-time authorization code）

:up:

找回密码

PUT /account/password/reset

无需权限验证，参数：

• ot_token, 字符串，一次使用的验证令牌
• password, 处理过的密码字符串，新密码

返回成功或失败

:up:

修改密码

PUT /account/password

参数：

• password, 处理过的密码字符串，新密码
• old_password, 处理过的密码字符串，之前的密码

返回成功或失败

:up: