cfapiNova UI

开发者中心

从注册插件到上架,全流程走接口完成。下面四步是最短路径。

  1. 1

    登录开发者账号

    POST /api/auth/login 取 JWT;开发者层级决定权限:internal_advanced 可管理插件。

  2. 2

    注册插件

    POST /api/plugins,提交 code / name / version / type;code 全局唯一。

  3. 3

    接入能力

    数据、KV、存储、文件、配置、事件,按需接入;全部走插件作用域令牌。

  4. 4

    发布与自测

    发布站点或上传产物,用真实令牌跑通主流程后再申请上架。

三条身份通道

通道怎么拿用在哪
插件作用域令牌POST /api/plugins/{code}/token插件后端调平台能力
API Key后台创建,内部 / 外部两级你的服务器、脚本、CI
用户 JWT登录签发,OIDC 可取公钥验签代表终端用户操作

20 类接入协议

协议入口适用场景限制
HTTP / REST/api/plugins/{code}/...插件开发主通道统一 {code,message,data}
JSON-RPC 2.0POST /api/rpc脚本与批量调用8 个平台方法,支持批量
MCPPOST /api/mcpAI / Agent 工具接入8 个工具,initialize→tools/list→tools/call
ConnectRPCPOST /connect/cfapi.v1.{S}/{M}强类型 RPC3 服务 5 方法,json/proto 双 codec
gRPC(原生)——不支持二进制帧与 trailers
gRPC-Web(JSON)POST /api/grpc/{s}/{m}调试兼容JSON 封装,非二进制
GraphQLPOST /api/graphql多字段一次取12 字段,偏管理面
WebSocketGET /ws?token=实时系统事件需 JWT;全站订阅限内部层级
SSEGET /api/events轻量事件流仅 system_event / error
Webhook/api/plugins/{code}/hooks插件事件回调首选带投递记录与重试
OpenAPIGET /api/openapi.json生成 SDKOpenAPI 3.1.0
OAuth2POST /api/oauth/token终端用户授权授权码流程
OIDC/api/oauth/.well-known/...发现 + JWKS可自行验签用户令牌
JWTAuthorization: Bearer用户身份EdDSA(Ed25519)
APIKeyAuthorization: Bearer服务端到服务端内部/外部两级,外部最小权限
AdminAPI/api/admin/*平台管理需管理员,不是插件接口
MetricsAPIGET /metricsPrometheus 抓取运维面
HealthCheckGET /api/health探活运维面
CLIscripts/cfapi-cli.sh运维脚本不是插件接口
SAML2/api/saml/*企业单点登录需 IdP 配置

插件作用域端点

数据与状态

  • /data/{collection} 文档 CRUD 与 Schema
  • /kv/{key} 带 TTL 的键值
  • /store 插件私有状态
  • /config 配置与 Schema

文件与事件

  • /storage/objects 对象存储
  • /files 上传与下载
  • /hooks Webhook 回调
  • /ai/chat 与 /payments

参考模板

模板类型说明
Nova UI 全站模板nova_ui本页所在的整站界面模板,可直接复用或二次修改
可视化表单搭建器local拖拽生成表单,数据直接入库
BUG 错误接收仓local接收前端异常并聚合为工单