cfapiNova UI

接口文档

先看鉴权与响应格式，再按能力查端点。所有接口返回同一套结构，便于统一处理错误。

快速开始

1. 取令牌

curl -X POST https://cfapi.aog.cc/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"your-name","password":"***"}'

2. 调接口

curl https://cfapi.aog.cc/api/plugins/{code}/data/{collection} \
  -H "Authorization: Bearer $TOKEN"

响应规范

{ "code": 0, "message": "ok", "data": { } }

code=0 为成功；非 0 时 message 可直接展示给用户。HTTP 状态码同时生效：401 未登录、403 无权限、404 不存在、429 限流、5xx 服务异常。

错误码

HTTP含义怎么处理
400参数错误按 message 修正字段
401未登录或过期重新登录或刷新令牌
403无权限检查层级授权与 scope
404资源不存在核对 code 与文档 id
429触发限流退避重试，勿并发轰炸

鉴权要点

  • 插件令牌只在所属插件命名空间内有效
  • API Key 分内外两级，外部默认最小权限
  • 用户 JWT 为 EdDSA，可用 JWKS 离线验签
越权调用返回 403 并记录审计，不要把它当作偶发故障重试。