17c31d7a1b
- 将大型API文档拆分为多个分类子文档 - 更新文档内容，添加新的API接口说明 - 修复文档中的格式问题和错别字 - 添加反馈文档和Github链接 - 优化侧边栏结构，支持不同路径的独立配置
1.8 KiB
1.8 KiB
身份认证相关
管理员登录接口用于获取后续调用其他管理员接口所需的临时 Token。
除登录接口外，所有管理员接口都需要在请求头中携带 Bearer Token。
Authorization: Bearer <token>
Token 通过登录接口获取，有效期为 24 小时。
1.1 管理员登录
POST /admin/login
管理员登录，获取后续调用其他管理员接口所需的临时 Token。
- 方法：
POST - 路径：
/admin/login - 鉴权：不需要
请求头
| 名称 | 必填 | 示例 |
|---|---|---|
Content-Type |
是 | application/json |
请求体
{
"name": "admin@example.com",
"password": "your_password"
}
字段说明：
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
name |
string | 是 | 管理员登录名 |
password |
string | 是 | 管理员登录密码 |
管理员登录名和密码由后端环境变量控制，字段为：
ADMIN_NAMEADMIN_PASSWORD
成功响应
- 状态码：
200
{
"data": {
"key": "f6e1e0e3-3c9b-4a24-9e88-3b1f709f1e4a"
}
}
前端需要将 data.key 作为 Token 存储（例如 LocalStorage），并在后续请求中通过 Authorization: Bearer <key> 携带。
错误与风控
-
登录失败（用户名或密码错误）：
- 状态码：
401
{ "message": "Invalid username or password", "failedAttempts": 3 } - 状态码：
-
登录失败次数过多导致 IP 被封禁：
- 状态码：
403
{ "message": "IP is blocked due to multiple failed login attempts" } - 状态码：
-
内部错误：
- 状态码：
500
{ "message": "错误信息" } - 状态码：