Vue d'ensemble : API d'expérience sur la page

Introduction

Il existe deux API associées aux expériences sur la page, mais elles sont utilisées à des fins très différentes :

API d'expériences sur la page (REST)

L'API In-Page Experiences est une API REST qui vous permet de gérer les In-Page Experiences par programmation. Il est principalement destiné à être utilisé pour intégrer la plate-forme Video Cloud à votre application CMS.

Voir aussi l'intégralité Référence API pour plus de détails sur les demandes disponibles.

API client d'expériences sur la page

L'API client In-Page Experiences est une bibliothèque JavaScript qui vous aide à gérer le comportement de l'In-Page Experience au moment de l'exécution, de la même manière que l'API Brightcove Player est utilisée pour contrôler le comportement du lecteur. L'API est disponible sur n'importe quelle page qui exécute une ou plusieurs expériences intégrées Brightcove. Voir la vue d'ensemble : API client d'expérience sur la page pour plus d'informations.

Le reste de cette présentation traite de l'API REST pour gérer vos expériences sur la page sur le backend.

Pour une présentation générale des expériences sur la page, voir Présentation : Création, modification et publication d'expériences internes à la page.

Les sections qui suivent donnent un aperçu des 4 groupes de requêtes d'API REST :

• Expériences
• Modèles
• Thèmes
• Polices

Expériences

Les demandes d'expériences se répartissent en trois sous-catégories :

Gérer les expériences

Ces requêtes vous permettent d'obtenir une liste de toutes les expériences pour le compte. Vous pouvez également créer une nouvelle expérience et obtenir, mettre à jour ou supprimer une expérience spécifique. Enfin, vous pouvez dupliquer une expérience pour créer un point de départ pour une nouvelle.

Publier/Dépublier des expériences

Ces requêtes permettent d'obtenir une liste de tous les modèles pour le compte ou un modèle particulier.

Gérer le statut des expériences en direct

Ces deux demandes vous permettent soit d'obtenir le statut actuel d'une expérience en direct, soit de modifier cet état (de preEvent à live, par exemple).

Modèles

Les modèles contrôlent l'apparence générale d'une expérience. Les modèles personnalisés ne peuvent pas être créés, mais il existe plusieurs modèles standard, et d'autres peuvent être ajoutés au fil du temps. L'API vous permet d'obtenir une liste des modèles disponibles pour votre compte, ou de récupérer un modèle spécifique.

Thèmes

Les thèmes vous permettent de personnaliser un modèle pour créer l'apparence que vous souhaitez pour votre expérience. L'API fournit des méthodes pour gérer entièrement vos thèmes, en les créant, en les obtenant, en les mettant à jour ou en les supprimant.

Polices

Vous pouvez utiliser vos propres polices. Ces méthodes vous permettent d'ajouter des polices, de les mettre à jour, de les obtenir ou de les supprimer. Ce sont des polices Web, chargées via CSS.