近期更新
- 统一认证中间件:Token 过期/无效统一返回 401 + requiresLogin
- 新增刷新 Token 接口:
POST /api/v1/auth/refresh - 前端统一 API 客户端:自动刷新 Token 并重试原请求
- 任务执行可靠性增强:重试(指数退避)、超时与任务迁移
快速上手 · 认证与刷新
# 登录获取Token
curl -X POST https://api.pidbai.com/api/v1/auth/login \
-H "Content-Type: application/json" \
-d '{"email":"user@example.com","password":"password"}'
# 验证Token
curl -X GET https://api.pidbai.com/api/v1/auth/verify \
-H "Authorization: Bearer <token>"
# 刷新Token(即便过期也可解码用户并续期)
curl -X POST https://api.pidbai.com/api/v1/auth/refresh \
-H "Authorization: Bearer <expired_or_valid_token>"
// 前端推荐:统一客户端(已内置自动刷新与重试)
const res = await window.apiClient.request('/users/profile', { method: 'GET' });
if (res.success) {
console.log(res.data);
} else if (res.requiresLogin) {
// 将自动跳到登录页
}
API概览
基础信息
Base URL: /api
协议: HTTP/HTTPS
数据格式: JSON
字符编码: UTF-8
API版本: v1.0.0
认证方式
本API使用JWT (JSON Web Token) 进行身份认证。
在请求头中包含以下字段:
Authorization: Bearer <your-jwt-token>
响应格式
所有API响应都遵循统一的JSON格式:
{
"success": true,
"message": "操作成功",
"data": {
// 具体数据
},
"timestamp": "2024-01-01T00:00:00.000Z"
}