概述:頁內體驗API

本主題提供頁面內體驗 API 的概觀。

簡介

有兩個與頁面內體驗相關聯的 API,但它們用於非常不同的目的:

頁面內體驗 API (REST)

頁面內體驗 API 是一種 REST API,可讓您以程式設計方式管理頁面內體驗。它主要用於將視訊雲端平台與您的 CMS 應用程式整合。

另請參閱完整API參考有關可用請求的完整詳細信息。

頁面內體驗用戶端 API

頁面內體驗用戶端 API 是一個 JavaScript 程式庫,可協助您在執行階段管理頁面內體驗的行為,類似 Brightcove 播放程式 API 用來控制播放程式行為的方式。此 API 可在執行一或多個 Brightcove 嵌入式體驗的任何頁面上提供。請參閱概觀:頁內體驗客戶端API欲獲得更多信息。

本概觀的其餘部分涉及 REST API,用於在後端管理頁面內體驗。

有關頁內體驗的一般介紹,請參見概述:建立、編輯和發佈頁面內體驗

下列各節提供 4 個 REST API 要求群組的概觀:

體驗

體驗要求分為三個子類別:

管理體驗
這些要求可讓您取得該帳戶的所有體驗清單。您也可以建立新的體驗,以及取得、更新或刪除特定體驗。最後,您可以複製體驗,以建立新體驗的起點。
發佈/取出發佈體驗
這些請求全部獲取帳戶或特定模板的所有模板列表。
管理即時體驗的狀態
這兩個請求使您可以獲取實時體驗的當前狀態或更改該狀態(從preEvent live, 例如)。

範本

範本控制體驗的整體外觀和感覺。無法建立自訂樣板,但有數個標準樣板,隨著時間的推移可能會加入更多樣板。API 可讓您取得帳戶可用的範本清單,或擷取特定範本。

佈景主題

主題可讓您自訂範本,以建立您想要的體驗外觀和風格。API 提供方法來完全管理您的主題,創建,獲取,更新或刪除它們。

字型

您可以使用自己的字體。這些方法可以讓您添加字體,更新它們,獲取它們或刪除它們。這些是網頁字體,通過 CSS 加載。