Appearance
登录与注册
注册账号
POST /api/login/register认证:不需要
参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
account | string | 是 | 账号 |
password | string | 是 | 密码 |
password_confirm | string | 是 | 确认密码 |
code | string | 否 | 短信验证码 |
mobile | string | 否 | 手机号 |
账号登录
支持账号密码、手机号密码、手机号验证码三种方式。
POST /api/login/account认证:不需要
参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
account | string | 是 | 账号 / 手机号 |
password | string | 条件 | 密码(密码登录时必填) |
code | string | 条件 | 验证码(验证码登录时必填) |
scene | int | 是 | 登录场景 |
响应示例:
json
{
"code": 1,
"data": {
"token": "eyJhbGciOiJIUzI1NiIs...",
"user_id": 1
}
}退出登录
POST /api/login/logout认证:不需要(有 Token 则清除)
微信公众号登录
POST /api/login/oaLogin认证:不需要
参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
code | string | 是 | 微信授权 code |
微信小程序登录
POST /api/login/mnpLogin认证:不需要
参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
code | string | 是 | 微信 wx.login() 返回的 code |
获取微信授权链接
GET /api/login/codeUrl认证:不需要
参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
url | string | 是 | 回调地址 |
获取扫码登录地址
GET /api/login/getScanCode认证:不需要
参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
url | string | 是 | 扫码回调地址 |
扫码登录
POST /api/login/scanLogin认证:不需要
小程序绑定微信
POST /api/login/mnpAuthBind认证:需要
公众号绑定微信
POST /api/login/oaAuthBind认证:需要
更新头像昵称
POST /api/login/updateUser认证:需要
获取可用登录方式
获取包含插件注册的第三方登录方式列表。
GET /api/login/loginMethods认证:不需要
参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
terminal | int | 否 | 终端类型 |
响应示例:
json
{
"code": 1,
"data": [
{
"login_way": "discord",
"name": "Discord登录",
"icon": "https://..."
}
]
}插件扩展
此接口通过 login_methods 钩子收集插件注册的登录方式,详见 插件系统。
插件授权跳转 URL
获取插件三方登录的授权跳转地址。
GET /api/login/pluginAuthUrl认证:不需要
参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
login_way | string | 是 | 登录方式标识 |
terminal | int | 否 | 终端类型 |
redirect_uri | string | 否 | 授权回调地址 |
插件三方登录
处理插件三方登录回调。
POST /api/login/pluginLogin认证:不需要
参数:
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
login_way | string | 是 | 登录方式标识 |
terminal | int | 是 | 终端类型 |
| 其他参数 | 由具体插件定义 |
响应:与账号登录相同,返回 token 和 user_id。