API 概述

该 Web 应用在 /api 路径下提供 HTTP API，应用和编辑器都使用它。本页面描述了该 API 的结构。路由本身位于 Web 应用的 api 目录中。

认证

API 通过会话进行身份验证。您通过认证端点登录，这些端点会设置会话 Cookie，后续请求将基于该会话进行授权。这与浏览器应用使用的会话是同一个。

作用域

请求的作用域限定于您的组织以及您的用户（在适用情况下）。您只能查看和更改自己的数据。

资源领域

API 围绕产品的资源进行组织，包括：

• 认证：用于登录、注册和会话管理。
• 设计：用于项目及其版本。
• 资产：用于媒体，包括预签名上传到存储空间。
• 标签、品牌和日历：用于组织和审查工作。
• 表单：用于表单配置和提交。

上传

媒体上传使用预签名 URL，因此文件直接发送到您的 S3 兼容存储，而不是通过应用。参见架构。

阅读路由

有关确切的端点和负载，请阅读 Web 应用中的路由处理器。它们是 API 演进的权威来源。