# OTT 平台 REST API | 自动化管理内容库 | Vodlix

**Source:** https://vodlix.com/zh/features/restful-api  
**Summary:** 用代码驱动您的流媒体平台。通过覆盖管理后台全部功能的 API，管理视频、剧集、直播频道、图片素材和内容列表。  
**Publisher:** Vodlix

---

## RESTful API

获取强大、安全的 REST API，快速完成集成、自动化流程并简化工作流。

- **Feature Plan:** 2

- core-platform
- back-end

通过与管理后台一一对应的 REST API，管理内容库、图片素材、直播频道、内容运营和报表。

笔记本电脑上显示的平台 API 文档中的«Add New Video»调用，手机应用中打开着同一部影片

“Update Content Thumbs”的 API 文档，可通过图片 URL 设置影片的竖版、横版和标志图片素材

### 通过 API 管理图片素材和直播频道

通过 Vodlix API，图片素材通过 URL 关联，而无需手动上传。一次调用即可设置影片的竖版、横版和标志图片，另一次调用则选择用哪一帧生成画面作为缩略图。直播频道的处理方式与视频相同：通过流地址创建，并可更新、发布或取消发布、移入回收站或恢复，因此线性内容也能像点播内容一样实现自动化。对于规模庞大或频繁变动的内容库，这能让图片素材保持一致，无需任何人逐个上传文件。

#### REST API

熟悉且可预期。

#### 与后台一一对应

熟悉界面，就熟悉 API。

#### 完整生命周期

创建、发布、取消发布、恢复。

“Upload with URL”的 API 文档，可通过公开存储、S3 或 Wasabi 上的文件 URL 导入视频

### 以编程方式管理内容库

借助 Vodlix REST API，您可以像在管理后台中一样以编程方式管理内容库。视频可以创建、更新、发布或取消发布，也可以移入回收站或恢复。剧集和季以同样的方式创建、更新和发布，单集可以关联到某一季或从中解除关联。导入新视频时，只需向平台提供文件 URL，可以是公开地址，也可以位于您自己的 S3 或 Wasabi 存储中：平台会在后台获取并处理文件，并返回一个视频 ID 供您跟踪进度。对于已有现成系统的 OTT 运营商，内容库管理可以实现自动化，而无需手动操作。

店面首页上的“Top 10”和“Rent the Latest”栏目，这些内容列表可通过 API 调用开启或关闭

### 由 API 控制的内容运营与内容列表

Vodlix API 让您掌控内容运营：内容列表、列表组及其条目和排序都可以通过编程方式创建和管理。列表可以启用和停用，因此季节性栏目只需一次 API 调用即可关闭，无需重建。这样，排期系统和内容规划工具就能自动编排首页。正是由 API 控制的内容运营，让编辑工作流得以规模化。

- mx-auto

MCP Access 工具表，列出平台信息、内容和用户数量、内容库浏览以及销售汇总

### 参考与报表接口

Vodlix API 提供参考与报表调用：分类 ID、内容库数量和用户数量、任意日期范围的销售汇总，以及软件版本等平台信息。集成始终清楚自己操作的对象，并能适应平台的变化。访问基于在管理后台创建的 API 密钥：服务器密钥用于后端任务，客户端密钥用于浏览器代码，且永远无法访问管理路由。同样的调用还通过平台的 MCP 连接器开放给 AI 助手。

### 它通常在哪些场景最能发挥价值

常见场景包括迁移、内容导入和报表。从其他平台迁移内容库变成了 API 任务，而非手动工作，这正是“无需等待任何人”的上线与“以月计”的上线之间的区别。来自发行方或制作工作流的定期导入，一旦编写完成即可无人值守地运行。报表会将数据直接导入您财务团队已在使用的工具，而不必每周一请人导出屏幕数据。

它还能将您的平台与业务的其他部分连接起来。新影片一经发布，即可推送到您的 CMS 和营销网站；也可以将您的[内容列表](/zh/features/content-lists)交给推荐服务，再将结果写回。如果某项集成需要的功能超出 API 本身所能提供的范围，我们的[定制插件服务](/zh/services/custom-plugin)会在同一平台上开发缺失的部分。

如果您的云上配置了统计服务，即可通过 API 获取分析数据。建议在设置阶段就确认这一点，而不是事后才发现。[报表与分析](/zh/features/reports-and-analytics)页面介绍了具体的统计内容。

**Q: Vodlix REST API 可以控制哪些内容？**

Vodlix REST API 可控制内容库（包括视频、剧集、季和单集），以及图片素材、直播频道、内容列表与内容运营，还有参考与报表数据。

**Q: 视频文件是通过 Vodlix API 上传的吗？**

只需提供一个公开的 HTTPS URL，即可通过 Vodlix API 导入新视频。Vodlix 会获取并转码文件，您无需通过自己的基础设施传输二进制文件。

**Q: Vodlix API 与管理后台一致吗？**

是的。Vodlix REST API 与管理后台一一对应，采用熟悉的 REST 规范和可预期的响应，因此熟悉界面的人大致就知道 API 能做什么。

**Q: 我可以通过 Vodlix API 管理内容列表吗？**

可以。Vodlix 的内容列表、列表组及其条目和排序都可以通过 API 创建、更新、启用和停用，从而实现内容运营自动化。

**Q: Vodlix API 提供哪些报表数据？**

Vodlix API 提供内容库数量和用户数量、指定日期范围的销售汇总、分类 ID 以及软件版本等平台信息，让集成始终清楚自己操作的对象。

**Q: 每个 Vodlix 云的分类 ID 都相同吗？**

不相同，这也是最容易出错的地方。分类是按云划分的，因此请读取您所操作平台的分类列表，并使用其返回的 ID，而不要假设同一个名称在所有地方都对应同一个编号。

**Q: 我们可以通过 API 获取分析数据吗？**

如果您的云上配置了统计服务，可以获取，涵盖核心指标、实时活动和表现最佳的内容。由于该服务与内容库操作分开开通，建议在设置阶段就加以确认。

**Q: API 对从其他平台迁移有帮助吗？**

这是运营商使用 API 最常见的原因之一。以编程方式迁移内容库，可将迁移变成可重复执行的任务，而不是数月的手动录入；还可以再次运行，以同步迁移期间发生的任何变更。

**Q: 集成如何通过 Vodlix API 进行身份验证？**

使用在管理后台“Apps & APIs”中创建的 API 密钥，并通过 X-Api-Key 请求头发送。服务器密钥以其所属用户的权限执行操作，可以访问管理路由，因此应在后端使用。客户端密钥可安全用于浏览器代码，并被禁止访问所有管理路由。密钥可以设置到期日期，删除密钥会立即将其吊销。