Media
最后更新:2026年7月3日
CDA(Content Delivery API)是一个只读 API,用于将已发布的资源传递给公开访问者。本页介绍如何查询已发布的 Media(即图片、视频、文档等文件资产),并获取其传递地址。CDA 传递的是发布时刻的快照,因此在内容工作室中尚未发布的 Media 不会出现在这里。
CDA 只提供查询(GET)端点,上传、修改和发布 Media 的操作由 CMA Media 负责。认证和发布传递模型(发布快照、revision、仅显示已发布项)等 CDA 通用行为,请参阅 CDA 概览。与其他已发布资源不同,Media 始终省略作者信息(createdBy、updatedBy)。title、description、file 返回查询所用 locale 的单个值(若 locale=* 则返回完整映射)。
资源结构
下面是 CDA 以 locale=ko-KR 单条查询并传递演示 Space 中一条已发布 Media("스테인리스 텀블러 500ml" 商品照片)的形态。它包含 sys(系统属性),以及包含该 locale 的 title、description、file 的 fields。
{
"sys": {
"id": "3trmXRM3RqbgSnifyg7OGjUMsPV3uU",
"type": "Media",
"space": { "sys": { "id": "HnQ32YiH", "type": "Refer", "targetType": "Space" } },
"createdAt": "2026-06-15T15:17:30.589Z",
"updatedAt": "2026-06-15T15:17:30.810Z",
"revision": 1
},
"fields": {
"title": "스테인리스 텀블러 500ml 정면 컷",
"description": "흰 배경에서 찍은 텀블러 정면 제품 사진입니다.",
"file": {
"fileName": "tumbler.png",
"contentType": "image/png",
"mimeGroups": ["Image"],
"url": "https://weegloo-media.com/medias/HnQ32YiH/3uU/3trmXRM3RqbgSnifyg7OGjUMsPV3uU/ko-KR/1/tumbler.png",
"detail": {
"size": 50847,
"image": { "width": 900, "height": 900 }
}
}
}
}主要键:
sys.id:Media 的唯一标识符。用于单条查询路径中的{mediaId}。sys.revision。CDA 不包含管理用的version,因此指向发布版本的值只有revision一个。fields.title、fields.descriptionlocale的单个值(不是 locale 映射)。fields.filelocale 下单个文件的对象。向访问者展示文件的传递地址是file.url。对象键在下方 fields 中说明。
系统属性 (sys)
已发布 Media 的 sys 只包含发布快照所需的属性。space 以 Refer 形态({ "sys": { "id", "type": "Refer", "targetType" } })出现。
| 属性 | 类型 | 说明 |
|---|---|---|
id | string | 资源唯一标识符。 |
type | string | 资源种类。Media 始终为 "Media"。 |
space | Refer<Space> | 此 Media 所属的 Space。 |
createdAt | string (date-time) | 创建时间。 |
updatedAt | string (date-time) | 最后修改时间。 |
revision | integer | 公开时刻的版本。每次发布时,该时刻的版本都会记录在此。 |
由于是发布快照,CMA 的 sys 中的 version、status、publish、archive 不会包含在内。指向发布版本的值只有 revision 一个。作者信息(createdBy、updatedBy)在传递响应中也始终省略。
fields
fields 包含请求的 locale 的单个值。CMA 会像 fields.title.ko-KR 那样返回包含所有 locale 值的映射,而 CDA 则挑出请求的单个 locale 的值直接放入。
| 键 | 类型 | 说明 |
|---|---|---|
title | string | Media 的标题。请求的 locale 的单个值。 |
description | string | Media 说明。请求的 locale 的单个值。 |
file | object | 该 locale 下的单个文件。参见下表。 |
file 对象的键如下。
| 键 | 类型 | 说明 |
|---|---|---|
fileName | string | 原始文件名。 |
contentType | string | 文件的 MIME 类型(例如 image/png)。 |
mimeGroups | string[] | 文件所属逻辑分类的数组。值为 Attachment、Plaintext、Image、Audio、Video、RichText、Presentation、Spreadsheet、PdfDocument、Archive、Code、Markup 这 12 种中的一种或多种。 |
url | string | 向访问者传递文件的 CDN 地址。 |
detail | object | 文件元信息。包含 size(以字节为单位的大小);若为图片则额外包含 image(width、height),若为视频则额外包含 video。 |
API
以下两个端点的基准 URL 为 https://cda.weegloo.com/v1,并需要在 Authorization 头中提供认证 CDA 的 Bearer 令牌。两个端点都通过 locale 查询参数确定要接收的语言。提供代码(如 locale=ko-KR)时返回该 locale 的值,省略时返回 Space 的默认 Locale,locale=* 时返回完整的 locale 映射。前两种情况下会附带 x-weegloo-locale 头,告知实际使用的 locale。
相关文档
- CDA Content Media 的已发布 Content。
- CMA Media Media 的 API。
- Media (概念)。
