API 参考

最后更新:2026年7月3日

本参考是面向在代码中直接使用 WEEGLOO 的开发者的 HTTP API 规范。各资源页面的端点块会渲染为可以直接填入路径、请求头、请求体并实际发起调用的控制台。你可以当场确认请求长什么样、响应会以什么形态返回。

AI 代理不直接调用此 HTTP API,而是使用 WEEGLOO MCP 工具。以下规范用于在前端、后端、脚本等应用代码中直接调用 API 的场景。

API 与 Base URL

WEEGLOO 按用途划分提供多个 API。请为要调用的 API 选用对应的 Base URL。不要推测或改写主机地址。

API用途Base URL
CMA内容管理(由 Weegloo User 创建、修改、删除)https://cma.weegloo.com
CDA已发布内容的交付(只读,基于缓存)https://cda.weegloo.com
Upload文件上传https://upload.weegloo.com
ACMA应用成员(ServiceUser)内容管理https://acma.weegloo.com
ACDA应用成员(ServiceUser)交付(只读)https://acda.weegloo.com
AuthServiceUser OAuth 登录与令牌https://auth.weegloo.com

路径以 /v1/... 为基准。例如某个 Space 内的 Content 列表为 https://cma.weegloo.com/v1/spaces/{spaceId}/contents

身份与令牌

WEEGLOO 拥有两套完全分离的身份体系。能够调用哪些 API,取决于令牌由哪种身份签发。

Weegloo User 是 WEEGLOO 平台账户。通过社交登录等方式首次登录时,账户就会当场创建(首次登录即注册)。不过,若要处理某个 Space 的内容,你必须是该 Space 的成员,而成员资格由已在其中的人发出邀请并授予 SpaceRole 来确定。也就是说,账户本身可以自由创建,但能进入哪个 Space、能做什么,则由成员资格和角色来控制。该身份的 Bearer 令牌(用于服务器与 CI 的 PersonalAccessToken,或通过内容工作室登录获取的令牌)可对 CMA、Upload、CDA 进行鉴权。对于向浏览器暴露的公开交付,应使用将权限收窄到最小的 DeliveryAccessToken(CDA),而不是令牌。

ServiceUser 是注册到产品的 end-user(通过 ServiceLogin 注册)。向谁开放注册、以及新注册是否需要管理员审批,都由 ServiceLogin 设置决定。该身份的 Bearer 令牌(由 auth.weegloo.com 签发)可对 ACMA、ACDAUpload 进行鉴权。不能用于 CMA、CDA。

令牌不会跨越身份边界。ServiceUser 令牌不可发送至 CMA、CDA,而 Weegloo User 令牌也不是 ACMA、ACDA 的有效调用方。两种身份共享的表面只有 Upload 一个,上传之后创建 Media 的位置会依身份分流为 CMA(Weegloo User)或 ACMA(ServiceUser)。

通用约定

以下四项不局限于特定资源,而是对所有调用通用。各个资源页面均以遵循这些约定为前提,仅讲解各自特有的内容。

  • 系统属性 (sys):所有资源的 sys 元数据结构(idversionRefer、发布状态)。
  • 通用查询参数:列表查询(limitorderfilter)与基于游标的分页。
  • 约定:响应媒体类型、部分修改(JSON Patch)、并发控制(X-Weegloo-Version)。
  • 错误:错误响应格式与通用代码。

资源参考

各 API 的资源规范在以下中心页面中讲解。

  • CMA:内容建模与管理Content TypeContentMediaTagLocale,以及令牌、组织、Space、角色、WebhookWebHostingServiceLogin 等管理资源。
  • CDA:交付:以只读方式交付已发布的内容。
  • Upload:上传文件以获取用于创建 MediaWebHostingUpload
  • AuthServiceUser OAuth 登录与令牌交换。
  • ACMA:应用成员(ServiceUser)的内容管理。
  • ACDA:向应用成员(ServiceUser)交付已发布的内容。