客户 API 参考

这份只读参考覆盖身份认证、API 密钥、工作区、构建、项目、处理器、产物、计费、分析和账户管理十组共 74 个客户操作。操作页中的方法、路径、安全要求、响应状态、媒体类型和 Schema 均由经过审查的 OpenAPI 契约生成;正文负责解释如何安全地使用该契约。

Reference 不会要求输入 JWT 或 nfy_ 密钥,也不会发送业务 API 请求。在兼容发布周期内,依赖旧流程的团队仍可使用临时保留的 Swagger UI;新集成应使用这些页面和机器可读的 /v3/api-docs 契约。

认证边界

  • Public 操作不需要凭据。
  • Dashboard 和账户操作需要 JWT access token。
  • Canonical 文档在构建、项目、已保存处理器、分析和自停用操作上公开带 scope 的 nfy_ automation key;每个操作页都会标明最低及条件 scope。
  • Legacy /api/v1/compile/** 路由也识别这些密钥,并继续为兼容目的运行,但会从 canonical 契约和导航中省略。

自动化构建前请先阅读 API 密钥与认证,实现轮询或重新提交前请阅读 错误、限制与重试。