API 文档

BeeQuant 平台提供完整的 RESTful API 接口，所有接口均返回 JSON 格式数据。

基础信息

API 请求的基础配置信息

Base URL

https://api.beequant.com/api

认证方式

除认证相关接口外，其他接口需要在请求头中携带 JWT Token：Authorization: Bearer YOUR_TOKEN

响应格式

所有 API 响应均为 JSON 格式，包含 success 字段表示请求是否成功。

ID 格式

所有资源的 ID 均使用 UUID 格式 (例如: 550e8400-e29b-41d4-a716-446655440000)

POST/api/auth/register

用户注册

请求体参数

参数名	类型	必填	描述
username	string	是	用户名 (最少3个字符)
email	string	是	邮箱地址
password	string	是	密码 (最少6个字符)

响应示例

{
  "success": true,
  "message": "注册成功",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": "uuid",
    "username": "newuser",
    "email": "user@example.com",
    "name": "newuser"
  }
}

POST/api/auth/login

用户登录验证

请求体参数

参数名	类型	必填	描述
email	string	是	邮箱地址
password	string	是	密码

响应示例

{
  "success": true,
  "message": "登录成功",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": "uuid",
    "username": "admin",
    "email": "admin@gmail.com",
    "name": "admin"
  }
}

POST/api/auth/send-verification

发送邮箱验证码

请求体参数

参数名	类型	必填	描述
email	string	是	邮箱地址

响应示例

{
  "success": true,
  "message": "验证码已发送"
}

POST/api/auth/verify-code

验证邮箱验证码

请求体参数

参数名	类型	必填	描述
email	string	是	邮箱地址
code	string	是	验证码

响应示例

{
  "success": true,
  "message": "验证成功"
}

POST/api/auth/logout

用户登出

响应示例

{
  "success": true,
  "message": "登出成功"
}

POST/api/auth/forgot-password

忘记密码 - 发送重置邮件

请求体参数

参数名	类型	必填	描述
email	string	是	注册邮箱地址

响应示例

{
  "success": true,
  "message": "重置密码邮件已发送"
}

POST/api/auth/reset-password

重置密码

请求体参数

参数名	类型	必填	描述
token	string	是	重置令牌
newPassword	string	是	新密码 (最少6个字符)

响应示例

{
  "success": true,
  "message": "密码重置成功"
}

POST/api/auth/verify-reset-code

验证密码重置验证码

请求体参数

参数名	类型	必填	描述
email	string	是	邮箱地址
code	string	是	验证码

响应示例

{
  "success": true,
  "message": "验证成功"
}

参数名

类型

必填

描述

username

string

是

用户名 (最少3个字符)

string

是

邮箱地址

password

string

是

密码 (最少6个字符)

{ "success": true, "message": "注册成功", "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "user": { "id": "uuid", "username": "newuser", "email": "user@example.com", "name": "newuser" } }

参数名

类型

必填

描述

string

是

邮箱地址

password

string

是

密码

{ "success": true, "message": "登录成功", "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "user": { "id": "uuid", "username": "admin", "email": "admin@gmail.com", "name": "admin" } }

参数名

类型

必填

描述

string

是

邮箱地址

参数名

类型

必填

描述

string

是

邮箱地址

code

string

是

验证码

参数名

类型

必填

描述

string

是

注册邮箱地址

参数名

类型

必填

描述

token

string

是

重置令牌

newPassword

string

是

新密码 (最少6个字符)

参数名

类型

必填

描述

string

是

邮箱地址

code

string

是

验证码