认证模块
文档所属项目:花枫咖啡馆Internal API文档 (/wiki/flowermaplechatapi)
花枫咖啡馆内部扩展 API — 认证模块 (Auth)
基础信息
- 前缀URL:
/v1/internal/auth - 主要功能: 邮箱验证、重发激活邮件、邮箱/用户名密码重置及 Token 校验。
接口列表
1. 邮箱验证
GET /v1/internal/auth/verify-email
用于通过邮件中的验证 Token 激活用户账户。
查询参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| token | string | 是 | 邮箱验证 Token |
响应
返回 text/html; charset=utf-8 文本/页面。
- 成功:
Email verification successful! - 失败(400):
Invalid verification token - 错误(500):
Server error
2. 重新发送验证邮件
POST /v1/internal/auth/resend-verification
针对未验证邮箱的用户重新发送激活邮件。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| string | 是 | 注册邮箱 |
请求示例
{
"email": "user@example.com"
}
成功响应示例
{
"success": true,
"message": "Verification email sent"
}
失败响应示例
{
"error": "Email already verified"
}
3. 忘记密码(通过邮箱)
POST /v1/internal/auth/forgot-password/email
通过邮箱发起密码重置请求。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| string | 是 | 用户注册邮箱 |
请求示例
{
"email": "user@example.com"
}
成功响应示例
{
"success": true,
"message": "Reset link sent to email"
}
4. 忘记密码(通过用户名)
POST /v1/internal/auth/forgot-password/username
通过用户名发起密码重置请求,重置邮件将发送至关联的注册邮箱。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| username | string | 是 | 用户名 |
请求示例
{
"username": "zhangsan"
}
成功响应示例
{
"success": true,
"message": "Reset link sent to registered email"
}
5. 验证重置密码令牌
POST /v1/internal/auth/reset-password/validate
校验密码重置 Token 是否有效或过期。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| token | string | 是 | 重置密码 Token |
请求示例
{
"token": "reset_token_xyz123"
}
成功响应示例
{
"valid": true,
"username": "zhangsan"
}
失败响应示例
{
"error": "Token expired or invalid"
}
6. 重置密码
POST /v1/internal/auth/reset-password
使用有效的重置 Token 修改新密码。
请求参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| token | string | 是 | 重置密码 Token |
| password | string | 是 | 新密码(至少 8 个字符) |
请求示例
{
"token": "reset_token_xyz123",
"password": "newpassword123"
}
成功响应示例
{
"success": true,
"message": "Password reset successfully"
}
