概述:頁面內體驗 API
介紹
有兩個與頁面內體驗相關的 API,但它們用於非常不同的目的:
- 頁面內體驗 API (REST)
-
In-Page Experiences API 是一種 REST API,可讓您以編程方式管理 In-Page Experiences。它主要用於將視頻雲平台與您的 CMS 應用程序集成。
另見完整API參考有關可用請求的完整詳細信息。
- 頁面內體驗客戶端 API
-
In-Page Experiences Client API 是一個 JavaScript 庫,可幫助您在運行時管理 In-Page Experience 的行為,類似於 Brightcove Player API 用於控製播放器行為的方式。API 在運行一個或多個 Brightcove 嵌入式體驗的任何頁面上可用。見概述:頁面內體驗客戶端 API了解更多信息。
本概述的其餘部分介紹用於在後端管理頁面內體驗的 REST API。
有關頁內體驗的一般介紹,請參閱概述:創建、編輯和發布頁內體驗 .
以下部分概述了 4 組 REST API 請求:
經歷
經驗請求分為三個子類別:
- 管理體驗
- 這些請求允許您獲得該帳戶的所有體驗的列表。您還可以創建新體驗,以及獲取、更新或刪除特定體驗。最後,您可以復制一種體驗,為新體驗創建一個起點。
- 發布/取消發布體驗
- 這些請求都是為了獲取帳戶的所有模板或特定模板的列表。
- 管理現場體驗的狀態
- 這兩個請求允許您獲取實時體驗的當前狀態或更改該狀態(來自
preEvent
到live
, 例如)。
模板
模板控制體驗的整體外觀。無法創建自定義模板,但有幾個標準模板,並且隨著時間的推移可能會添加更多。API 允許您獲取您的帳戶可用的模板列表,或檢索特定模板。
主題
主題允許您自定義模板以創建您想要的體驗外觀。API 提供方法來完全管理您的主題,創建、獲取、更新或刪除它們。
字體
您可以使用自己的字體。這些方法允許您添加字體、更新它們、獲取它們或刪除它們。這些是通過 CSS 加載的網絡字體。