开放平台 API 文档#

基础路径#

/

接口列表#

应用管理#

获取应用列表#

GET /apps

获取已创建的应用，排除内部 system 应用；响应中的 tokens 数组为空。

创建应用#

POST /apps

请求体

{
  name?: string,      // 应用名称（不能为'system'）
  scopes?: string[]   // 权限范围
}

更新应用#

PUT /apps

请求体

{
  id: number,       // 应用ID
  name?: string,     // 应用名称
  scopes?: string[]  // 权限范围
}

删除应用#

DELETE /apps

请求体

number[]  // 应用ID数组

重置应用密钥#

PUT /apps/:id/reset-secret

重置指定应用的密钥，并清空已有令牌。调用方需要使用新密钥重新获取 token。

认证#

获取访问令牌#

GET /auth/token

查询参数

{
  client_id: string,     // 客户端ID
  client_secret: string  // 客户端密钥
}

错误处理#

• 所有接口遵循统一的错误处理机制
• 成功响应返回 { code: 200, data: ... }
• 错误日志由 Winston logger 处理

注意事项#

• 使用 celebrate/Joi 进行参数验证
• 应用名称不能使用保留字 'system'
• 支持批量删除应用
• 密钥重置操作不可逆