开发者中心
从注册插件到上架,全流程走接口完成。下面四步是最短路径。
- 1
登录开发者账号
POST /api/auth/login取 JWT;开发者层级决定权限:internal_advanced 可管理插件。 - 2
注册插件
POST /api/plugins,提交 code / name / version / type;code 全局唯一。 - 3
接入能力
数据、KV、存储、文件、配置、事件,按需接入;全部走插件作用域令牌。
- 4
发布与自测
发布站点或上传产物,用真实令牌跑通主流程后再申请上架。
三条身份通道
| 通道 | 怎么拿 | 用在哪 |
|---|---|---|
| 插件作用域令牌 | POST /api/plugins/{code}/token | 插件后端调平台能力 |
| API Key | 后台创建,内部 / 外部两级 | 你的服务器、脚本、CI |
| 用户 JWT | 登录签发,OIDC 可取公钥验签 | 代表终端用户操作 |
20 类接入协议
| 协议 | 入口 | 适用场景 | 限制 |
|---|---|---|---|
| HTTP / REST | /api/plugins/{code}/... | 插件开发主通道 | 统一 {code,message,data} |
| JSON-RPC 2.0 | POST /api/rpc | 脚本与批量调用 | 8 个平台方法,支持批量 |
| MCP | POST /api/mcp | AI / Agent 工具接入 | 8 个工具,initialize→tools/list→tools/call |
| ConnectRPC | POST /connect/cfapi.v1.{S}/{M} | 强类型 RPC | 3 服务 5 方法,json/proto 双 codec |
| gRPC(原生) | — | — | 不支持二进制帧与 trailers |
| gRPC-Web(JSON) | POST /api/grpc/{s}/{m} | 调试兼容 | JSON 封装,非二进制 |
| GraphQL | POST /api/graphql | 多字段一次取 | 12 字段,偏管理面 |
| WebSocket | GET /ws?token= | 实时系统事件 | 需 JWT;全站订阅限内部层级 |
| SSE | GET /api/events | 轻量事件流 | 仅 system_event / error |
| Webhook | /api/plugins/{code}/hooks | 插件事件回调首选 | 带投递记录与重试 |
| OpenAPI | GET /api/openapi.json | 生成 SDK | OpenAPI 3.1.0 |
| OAuth2 | POST /api/oauth/token | 终端用户授权 | 授权码流程 |
| OIDC | /api/oauth/.well-known/... | 发现 + JWKS | 可自行验签用户令牌 |
| JWT | Authorization: Bearer | 用户身份 | EdDSA(Ed25519) |
| APIKey | Authorization: Bearer | 服务端到服务端 | 内部/外部两级,外部最小权限 |
| AdminAPI | /api/admin/* | 平台管理 | 需管理员,不是插件接口 |
| MetricsAPI | GET /metrics | Prometheus 抓取 | 运维面 |
| HealthCheck | GET /api/health | 探活 | 运维面 |
| CLI | scripts/cfapi-cli.sh | 运维脚本 | 不是插件接口 |
| SAML2 | /api/saml/* | 企业单点登录 | 需 IdP 配置 |
插件作用域端点
数据与状态
/data/{collection}文档 CRUD 与 Schema/kv/{key}带 TTL 的键值/store插件私有状态/config配置与 Schema
文件与事件
/storage/objects对象存储/files上传与下载/hooksWebhook 回调/ai/chat与/payments
参考模板
| 模板 | 类型 | 说明 |
|---|---|---|
| Nova UI 全站模板 | nova_ui | 本页所在的整站界面模板,可直接复用或二次修改 |
| 可视化表单搭建器 | local | 拖拽生成表单,数据直接入库 |
| BUG 错误接收仓 | local | 接收前端异常并聚合为工单 |