Descripción general: API de experiencia en la página

Introducción

Hay dos API asociadas con las experiencias en la página, pero se utilizan para fines muy diferentes:

API de experiencias en la página (REST)

La API de experiencias en la página es una API REST que le permite administrar las experiencias en la página de forma programática. Está diseñado principalmente para su uso en la integración de la plataforma Video Cloud con su aplicación CMS.

También vea el completo Referencia de API para obtener detalles completos de las solicitudes disponibles.

API de cliente de experiencias en la página

La API de cliente de experiencias en la página es una biblioteca de JavaScript que le ayuda a administrar el comportamiento de la experiencia en la página en tiempo de ejecución, de forma similar a como se utiliza la API de Brightcove Player para controlar el comportamiento del reproductor. La API está disponible en cualquier página que ejecute una o más experiencias integradas de Brightcove. Ver el Descripción general: API de cliente de experiencia en la página para más información.

El resto de esta descripción general trata sobre la API REST para administrar sus experiencias en la página en el backend.

Para obtener una introducción general a las experiencias in-page, consulte Descripción general: Creación, edición y publicación de experiencias en la página.

Las secciones siguientes proporcionan una descripción general de los 4 grupos de solicitudes de API REST:

• Experiencias
• Plantillas
• Temas
• Fuentes

Experiencias

Las solicitudes de experiencias se dividen en tres subcategorías:

Gestionar experiencias

Estas solicitudes le permiten obtener una lista de todas las experiencias de la cuenta. También puede crear una nueva experiencia y obtener, actualizar o eliminar una experiencia específica. Finalmente, puede duplicar una experiencia para crear un punto de partida para una nueva.

Publicar / anular la publicación de experiencias

Todas estas solicitudes para obtener una lista de todas las plantillas para la cuenta o una plantilla en particular.

Administrar el estado de las experiencias en vivo

Estas dos solicitudes le permiten obtener el estado actual de una experiencia en vivo o cambiar ese estado (de preEvent a live, por ejemplo).

Plantillas

Las plantillas controlan el aspecto general de una experiencia. No se pueden crear plantillas personalizadas, pero hay varias plantillas estándar y es posible que se agreguen más con el tiempo. La API le permite obtener una lista de plantillas disponibles para su cuenta o recuperar una plantilla específica.

Temas

Los temas le permiten personalizar una plantilla para crear la apariencia que desea para su experiencia. La API proporciona métodos para administrar completamente sus temas, creándolos, obteniéndolos, actualizándolos o eliminándolos.

Fuentes

Puede utilizar sus propias fuentes. Estos métodos le permiten agregar fuentes, actualizarlas, obtenerlas o eliminarlas. Estas son fuentes web, cargadas a través de CSS.