将分散的API子页面内容合并到对应的主文档中,简化文档结构。具体合并内容包括: - 将 verify-admin.md 内容合并到 auth.md - 将 track-visit.md 内容合并到 analytics.md - 将 get-config.md 内容合并到 config.md - 将 get-comments.md、post-comment.md、like-comment.md 内容合并到 comments.md - 将 get-like-status.md、post-like.md 内容合并到 like.md 删除原有的独立子页面文件,使API文档更加集中和易于维护。
80 lines
1.3 KiB
Markdown
80 lines
1.3 KiB
Markdown
# 身份验证
|
|
|
|
管理员评论密钥验证接口,用于博主发布评论时的身份验证。
|
|
|
|
## 验证管理员密钥
|
|
|
|
```
|
|
POST /api/verify-admin
|
|
```
|
|
|
|
验证前台管理员评论所需的密钥,用于博主发布评论时的身份验证。
|
|
|
|
- 方法:`!POST`
|
|
- 路径:`/api/verify-admin`
|
|
- 鉴权:不需要
|
|
|
|
**请求头**
|
|
|
|
| 名称 | 必填 | 示例 |
|
|
| -------------- | ---- | ------------------ |
|
|
| `Content-Type` | 是 | `application/json` |
|
|
|
|
**请求体**
|
|
|
|
```json
|
|
{
|
|
"adminToken": "your-admin-key"
|
|
}
|
|
```
|
|
|
|
字段说明:
|
|
|
|
| 字段名 | 类型 | 必填 | 说明 |
|
|
| ----------- | ------ | ---- | -------------- |
|
|
| `adminToken` | string | 是 | 管理员评论密钥 |
|
|
|
|
**风控说明**
|
|
|
|
- 本地密钥存活时间 72 小时
|
|
- 同一 IP 连续验证失败 3 次后,该 IP 将被锁定 30 分钟
|
|
- 失败次数记录有效期为 1 小时
|
|
|
|
**成功响应**
|
|
|
|
- 状态码:`200`
|
|
|
|
```json
|
|
{
|
|
"message": "验证通过"
|
|
}
|
|
```
|
|
|
|
或未设置密钥时:
|
|
|
|
```json
|
|
{
|
|
"message": "未设置管理员密钥"
|
|
}
|
|
```
|
|
|
|
**错误响应**
|
|
|
|
- 密钥错误:
|
|
- 状态码:`401`
|
|
|
|
```json
|
|
{
|
|
"message": "密钥错误"
|
|
}
|
|
```
|
|
|
|
- 验证失败次数过多:
|
|
- 状态码:`403`
|
|
|
|
```json
|
|
{
|
|
"message": "验证失败次数过多,请 30 分钟后再试"
|
|
}
|
|
```
|