Überblick: In-Page-Experience API

Einleitung

Mit In-Page-Erlebnissen sind zwei APIs verbunden, die jedoch für sehr unterschiedliche Zwecke verwendet werden:

In-Page-Erlebnisse-API (REST)

Die In-Page-Erlebnisse-API ist eine REST-API, mit der Sie In-Page-Erlebnisse programmgesteuert verwalten können. Es ist in erster Linie für die Integration der Video Cloud-Plattform in Ihre CMS-Anwendung vorgesehen.

Sehen Sie auch die vollständige API-Referenz für vollständige Details der verfügbaren Anfragen.

In-Page-Erfahrungen-Client-API

Die Client-API für In-Page-Erfahrungen ist eine JavaScript-Bibliothek, mit der Sie das Verhalten der In-Page-Erfahrung zur Laufzeit verwalten können, ähnlich wie die Brightcove Player-API zum Steuern des Verhaltens des Players verwendet wird. Die API ist auf jeder Seite verfügbar, auf der eine oder mehrere eingebettete Brightcove-Erlebnisse ausgeführt werden. Siehe die Überblick: In-Page-Experience-Client-API für mehr Informationen.

Der Rest dieser Übersicht befasst sich mit der REST-API zur Verwaltung Ihrer In-Page-Erlebnisse im Backend.

Eine allgemeine Einführung in In-Page-Erlebnisse finden Sie unter Überblick: Erstellen, Bearbeiten und Veröffentlichen von In-Page-Erlebnissen.

Die folgenden Abschnitte bieten einen Überblick über die 4 Gruppen von REST-API-Anfragen:

• Erfahrungen
• Vorlagen
• Themen
• Schriftarten

Erfahrungen

Anfragen für Erfahrungen lassen sich in drei Unterkategorien einteilen:

Erfahrungen verwalten

Mit diesen Anfragen erhalten Sie eine Liste aller Erlebnisse für das Konto. Sie können auch eine neue Erfahrung erstellen und eine bestimmte Erfahrung abrufen, aktualisieren oder löschen. Schließlich können Sie ein Erlebnis duplizieren, um einen Ausgangspunkt für ein neues Erlebnis zu schaffen.

Erfahrungen veröffentlichen/veröffentlichen

Diese fordert alle auf, eine Liste aller Vorlagen für das Konto oder eine bestimmte Vorlage zu erhalten.

Status für Live-Erlebnisse verwalten

Mit diesen beiden Anfragen können Sie entweder den aktuellen Status eines Live-Erlebnisses abrufen oder diesen Status ändern (von preEvent Zu live , Zum Beispiel).

Vorlagen

Vorlagen steuern das allgemeine Erscheinungsbild einer Erfahrung. Benutzerdefinierte Vorlagen können nicht erstellt werden, es gibt jedoch mehrere Standardvorlagen und im Laufe der Zeit können weitere hinzugefügt werden. Mit der API können Sie eine Liste der für Ihr Konto verfügbaren Vorlagen abrufen oder eine bestimmte Vorlage abrufen.

Themen

Mit Designs können Sie eine Vorlage anpassen, um das gewünschte Erscheinungsbild für Ihre Erfahrung zu erstellen. Die API bietet Methoden, um Ihre Themen vollständig zu verwalten, zu erstellen, zu erhalten, zu aktualisieren oder zu löschen.

Schriftarten

Sie können Ihre eigenen Schriftarten verwenden. Mit diesen Methoden können Sie Schriftarten hinzufügen, aktualisieren, abrufen oder löschen. Dies sind Webfonts, die über CSS geladen werden.