Integrieren Sie Ihr CMS mit Video Cloud

In diesem Thema lernen Sie die grundlegenden Vorgänge bei der Integration von Brightcove kennen Video Cloud mit einem CMS. Es werden typische Funktionen aufgelistet, die Benutzer innerhalb des CMS ausführen, sowie die Brightcove-API-Vorgänge, mit denen diese Funktionalität bereitgestellt werden kann.

Benutzerfunktionen

Im Folgenden sind Funktionen im Zusammenhang mit Video Cloud dass Sie Benutzern Ihres CMS möglicherweise Folgendes bereitstellen möchten:

Füge neue Videos hinzu Video Cloud
Ersetzen Sie a Video Cloud Video mit einer neuen Version
Aktualisieren Sie Metadaten für Videos, z. B. Titel, Beschreibung und Tags
Videos löschen
Erstellen Sie Wiedergabelisten
Ändere die Videos in einer Playlist
Lösche Wiedergabelisten
Erstellen Sie Video-Player
Ändern Sie die Eigenschaften des Videoplayers, z. B. Abmessungen oder Styling
Fügen Sie Videoplayern über Plugins spezielle Funktionen hinzu
Veröffentlichen Sie einzelne Videos oder Wiedergabelisten
Bereitstellung von Analysedaten zu Ladezeiten, Views, Wiedergabegeschwindigkeiten, Engagement usw.

Sie möchten diese Funktionen möglicherweise nicht Ihren Endnutzern zugänglich machen - Sie möchten beispielsweise nicht, dass sie Videos löschen. Einer der Vorteile der Integration Video Cloud mit Ihrem CMS, anstatt die Benutzer direkt ansprechen zu lassen Video Cloud In Studio können Sie genau auswählen, welche Funktionen den Benutzern über die Brightcove-APIs zur Verfügung gestellt werden sollen.

Beglaubigung

Für alle Brightcove-API-Anforderungen basiert die Authentifizierung auf OAuth2-Zugriffstoken. Es gibt einen zweistufigen Prozess zum Abrufen von Zugriffstoken:

Erstellen Sie Clientanmeldeinformationen mit Berechtigungen für die erforderlichen API-Vorgänge
Verwenden Sie die Clientanmeldeinformationen, um ein temporäres Zugriffstoken zum Authentifizieren einer API-Anforderung zu erstellen

Client-Anmeldedaten erstellen

Das Erstellen von Client-Anmeldeinformationen ist eine einmalige Operation, die ausgeführt werden kann Video Cloud Studio oder OAuth API . Wie auch immer du es tust, a client_id und client_secret werden zurückgegeben, die Sie speichern müssen, um Zugriffstoken anzufordern.

Der client_secret wird nur angezeigt, wenn der Client-Berechtigungsnachweis erstellt wurde - er kann nie wieder abgerufen werden. Wenn Sie einen Client-Schlüssel verlieren, müssen Sie einen neuen Client-Berechtigungsnachweis erstellen.

Erstellen eines Zugriffstokens

Temporäre Zugriffstoken werden mit dem erstellt OAuth API dem „Vermischten Geschmack“. Seine client_id und client_secret muss BASE64-codiert sein und als a übergeben werden Basic Autorisierungszeichenfolge

Der access_token zurückgegeben wird in einem Autorisierungsheader mit dem API-Aufruf übergeben:

    >Authorization: Bearer your_access_token

Zugriffstoken sind für 5-Minuten gültig. Sofern Sie keine Batch-Operation durchführen, bei der Hunderte von aufeinander folgenden API-Aufrufen ausgeführt werden, ist es sinnvoll, für jeden API-Aufruf einfach eine neue Anforderung zu erstellen, anstatt zu versuchen, die Zeitüberschreitung zu protokollieren.

Hinzufügen von Videos

Wenn Sie möchten, dass Nutzer Videos hinzufügen können Video Cloud von Ihrem CMS aus können Sie das mit dem Dynamic Ingest API . Wir empfehlen, dass Nutzer Videos in Ihr Repository hochladen, bei dem es sich um einen S3-Bucket oder nur um einen öffentlich zugänglichen Server handeln kann. Das Dynamic Ingest-System kann die Videos einziehen und zu den Videos hinzufügen Video Cloud System durch einen zweistufigen Prozess, der unten beschrieben wird.

Hinzufügen eines Videoobjekts zu Video Cloud

Der erste Schritt besteht darin, ein Videoobjekt in der Video Cloud System, indem man a POST Anfrage an die CMS API:

    https://cms.api.brightcove.com/v1/accounts/:account_id/videos

Der Anfragetext enthält grundlegende Videoeigenschaften in einem JSON Objekt - minimal, das Video name, aber Sie können auch zusätzliche Metadaten wie z description und tags:

    {
    "name": "Woodpecker",
    "description": "A bird that hunts insects inside wood",
    "reference_id": "Bird_Woodpecker.mp4",
    "tags": ["bird", "air", "nature"]
    }

A reference_id kann zu jedem Video hinzugefügt werden. Referenz-IDs müssen innerhalb des Kontos eindeutig sein. Wenn Ihre Videos IDs in Ihrem CMS-System haben, empfiehlt es sich, diese ID als Referenz-ID zu verwenden Video Cloud System.

Das Video einlesen

Wenn Sie das Videoobjekt erstellen, wird das CMS API wird zurückgeben JSON Objekt mit den Videoeigenschaften. Du wirst das Video extrahieren id von dem JSON, und verwenden Sie es, um einen Anruf an die Dynamic Ingest API um die Aufnahme und Transkodierung des Videos anzufordern:

    https://ingest.api.brightcove.com/v1/accounts/ACCOUNT_ID/videos/VIDEO_ID/ingest-requests

Wieder wirst du senden JSON im Anfragetext, der den Speicherort der Videodatei angibt:

    {
      "master":{
        "url":"http://learning-services-media.brightcove.com/videos/mp4/Bird_Woodpecker.mp4"
      },
      "profile":"multi-platform-extended-static",
      "capture-images": true
    }

Der profile Hier ist das Ingest-Profil angegeben, das angibt, welche Darstellungen im Transcodierungsprozess erstellt werden sollen. In den meisten Fällen sollte eines der folgenden Standardprofile angemessen sein:

Dynamische Übermittlungsprofile

multi-platform-extended-static
multi-platform-standard-static

Legacy-Ingest-Profile

videocloud-default-v1 (the default)
screencast-1280
smart-player-transition
single-bitrate-high
audio-only
single-bitrate-standard
high-resolution

Sie können jedoch bei Bedarf zusätzliche benutzerdefinierte Ingest-Profile erstellen, indem Sie Ingest Profiles API oder mit Video Cloud Studio.

Wenn Sie Profile mit Hilfe der Ingest Profiles API die Ergebnisse für Legacy-Aufnahme-Accounts enthält Dynamic Delivery-Profile, die jedoch zu Fehlern führen. Sie müssen diese Profile auf der Clientseite filtern. Sie können Dynamic Delivery-Profile durch das Vorhandensein von a erkennen dynamic_origin Eigentum:

    {
        "version": 2,
        "name": "multi-platform-extended-static",
        "display_name": "Multiplatform Extended",
        "description": "Deliver high quality content for a wide range content types and screen sizes including mobile, desktop and large screens.",
        "account_id": -1,
        "brightcove_standard": true,
        "date_created": 1495114240899,
        "date_last_modified": 1503002227627,
        "digital_master": {
          "rendition": "passthrough",
          "distribute": false
        },
        "renditions": [
        ],
        "packages": [
        ],
        "dynamic_origin": {
          "renditions": [
            "default/audio64",
            "default/audio128",
            "default/video3800",
            "default/video700",
            "default/video3500",
            "default/video2000",
            "default/video1700",
            "default/video1200",
            "default/audio96",
            "default/video450",
            "default/video900",
            "default/audio192"
          ],
          "images": [
            {
              "label": "thumbnail",
              "height": 90,
              "width": 160
            },
            {
              "label": "poster",
              "height": 720,
              "width": 1280
            }
          ]
        },
        "id": "f1b16093e2dc4f81810f1488"
      }

Hinzufügen von Poster- und Thumbnail-Bildern

Der capture-images Option im obigen Code anweist Video Cloud um Poster und Miniaturbilder für das Video in der Mitte des Transcodierungsvorgangs aufzunehmen. Alternativ können Sie festlegen capture-images zu false und nehmen Sie stattdessen Bilder auf, entweder zur gleichen Zeit, zu der Sie das Video aufnehmen oder später:

    {
    "master":{
    "url":"http://learning-services-media.brightcove.com/videos/mp4/Bird_Woodpecker.mp4"
    },
    "profile":"multi-platform-extended-static",
    "capture-images": false,
    "poster": {
    "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-poster.png",
    "width": 640,
    "height": 360
    },
    "thumbnail": {
    "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-thumbnail.png",
    "width": 160,
    "height": 90
    }
    }

[VORLÄUFIGE VOLLAUTOMATISCHE TEXTÜBERSETZUNG - muss noch überarbeitet werden. Wir bitten um Ihr Verständnis.] Für eine detailliertere Anleitung gehen Sie bitte auf: Bilder und die Dynamic Ingest API für weitere Informationen kontaktieren.

Hinzufügen von Textspuren für Untertitel oder Kapitel

Sie können auch die Tasten Dynamic Ingest API um Textspuren hinzuzufügen WebVTT Dateien zu Videos, entweder zum Zeitpunkt der Einnahme oder später. Textspuren werden zum Hinzufügen verwendet Bildunterschriften or Kapitel zu einem Video.

    {
    "master":{
    "url":"http://learning-services-media.brightcove.com/videos/mp4/Bird_Woodpecker.mp4"
    },
    "profile":"multi-platform-extended-static",
    "capture-images": false,
    "poster": {
    "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-poster.png",
    "width": 640,
    "height": 360
    },
    "thumbnail": {
    "url": "http://learning-services-media.brightcove.com/images/for_video/titmouse-thumbnail.png",
    "width": 160,
    "height": 90
    },
    "text_tracks": [
    {
    "url": "http://learning-services-media.brightcove.com/captions/for_video/Water-in-Motion.vtt",
    "srclang": "en",
    "kind": "captions",
    "label": "English",
    "default": true
    }
    ]
    }

[VORLÄUFIGE VOLLAUTOMATISCHE TEXTÜBERSETZUNG - muss noch überarbeitet werden. Wir bitten um Ihr Verständnis.] Für eine detailliertere Anleitung gehen Sie bitte auf: WebTVT-Dateien erfassen für weitere Informationen kontaktieren.

Verwalten von Videos

Der CMS API Damit können Sie Videodaten für ein Konto abrufen. (Wie oben gezeigt, wird es auch zum Erstellen von Videoobjekten als Teil des Videoaufnahmeprozesses verwendet.) Die grundlegendste Anforderung lautet wie folgt:

    https://cms.api.brightcove.com/v1/accounts/account_id/videos

Standardmäßig gibt diese Anfrage a zurück JSON Array von 20-Videoobjekten, die eine Fülle von Metadaten enthalten, einschließlich Name, Beschreibung, Tags, benutzerdefinierte Felder, Datum der Erstellung und letzten Änderung, URLs für das Poster und Thumbnail und vieles mehr.

Sie können die Ergebnisse der Anfrage verfeinern, indem Sie der Anfrage einen oder mehrere der folgenden Parameter hinzufügen:

limit: Dies bestimmt die Anzahl der zurückzugebenden Videoobjekte und kann bis zu einer beliebigen Anzahl 100 festgelegt werden. Der Standardwert ist 20
offset: Dies bestimmt die Anzahl der zu überspringenden Elemente und wird daher zusammen mit verwendet limit um durch den Videokatalog zu blättern - der Standard ist 0
sort: Dadurch wird das Video-Metadatenfeld festgelegt, nach dem das Ergebnis sortiert wird. Standardmäßig werden die Ergebnisse sortiert updated_at (absteigend, um die zuletzt aktualisierten Videos zuerst anzuzeigen)

[VORLÄUFIGE VOLLAUTOMATISCHE TEXTÜBERSETZUNG - muss noch überarbeitet werden. Wir bitten um Ihr Verständnis.] Für eine detailliertere Anleitung gehen Sie bitte auf: CMS API Überblick - Parameter für detaillierte Informationen zu diesen Parametern.

Nach Videos suchen

Sie können nach Videos auch nach einer Vielzahl von Kriterien suchen q Parameter. Sie können nach bestimmten Feldern wie Name, Beschreibung und Tags sowie Datum und Status der Videos suchen:

    https://cms.api.brightcove.com/v1/accounts/account_id/videos?q=tags:sea,mammal

Einzelheiten und alle Suchmöglichkeiten finden Sie unter Suche nach Videos.

Ein bestimmtes Video herunterladen und aktualisieren

So rufen Sie ein bestimmtes Video anhand seiner ID oder Referenz-ID ab:

    https://cms.api.brightcove.com/v1/accounts/account_id/videos/id
    or
    https://cms.api.brightcove.com/v1/accounts/account_id/videos/ref:reference_id

A GET Anfrage gibt das Videoobjekt zurück. Um es zu aktualisieren, ändern Sie die JSON und gib es mit a zurück PATCH Anfrage an die gleiche URL.

Wiedergabelisten

Die Playlist-Informationen werden ebenfalls mit dem. Verwaltet CMS API ähnlich wie Video-Informationen. Beachten Sie, dass Video Cloud unterstützt acht Arten von Wiedergabelisten in zwei Kategorien:

Handbuch (oder EXPLICIT) Wiedergabelisten

enthält eine bestimmte Menge an Videos - bis zu 100-Videos können enthalten sein

Intelligente Wiedergabelisten

dynamisch zur Laufzeit basierend auf Suchkriterien erstellt - es gibt sieben verschiedene Smart Playlists, die der Reihenfolge der Videos in der Liste entsprechen:

ACTIVATEDOLDESTTONEWEST
ACTIVATEDNEWESTTOOLDEST
ALPHABETICAL
PLAYSTOTAL
PLAYSTRAILINGWEEK
STARTDATEOLDESTTONEWEST
STARTDATENEWESTTO_OLDEST

Das Limit für die Anzahl der Videos kann auf eine beliebige Anzahl bis zu 100 festgelegt werden.

Wie bei Videos können Sie alle Wiedergabelisten mit limit und offset Durchblättern der Ergebnisse, wenn das Konto eine große Anzahl von Wiedergabelisten enthält:

    https://cms.api.brightcove.com/v1/accounts/account_id/playlists

Das zurückgegebene Array von Wiedergabelistenobjekten enthält Metadaten für die Wiedergabeliste, einschließlich der type entsprechend dem einen der oben beschriebenen Typen. Wenn der Typ ist EXPLICIT, es wird auch eine sein video_ids Array mit den IDs der enthaltenen Videos. Wenn der Typ einer der Smart-Playlist-Typen ist, wird a search Eigenschaft, die die Suchzeichenfolge enthält, die die Videos abruft, etwa so:

    q=tags:fish,birds

Sie können auch eine einzelne Wiedergabeliste abrufen, indem Sie id:

    https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id

Wenn Sie die vollständigen Videoobjekte für eine Wiedergabeliste abrufen müssen (um Informationen zu den Videos auf einer Seite anzuzeigen), fügen Sie einfach hinzu /videos zu dieser URL:

    https://cms.api.brightcove.com/v1/accounts/account_id/playlists/playlist_id/videos

Beachten Sie, dass bei einer intelligenten Wiedergabeliste die Anfrage die Videos zurückgibt, die den Suchkriterien entsprechen. Dies kann sich jedoch ändern.

Spieler erstellen

Brightcove players können über die erstellt werden Player Management API . Die API ermöglicht es Ihnen, Spieler zu erstellen, ihre Eigenschaften zu aktualisieren und den Einbettungscode in Form einer URL zu erhalten iframe Tag oder ein HTML-Block zum Einbetten in die Seite.

Sie können bis zu 200-Spieler pro Konto haben, aber es ist im Allgemeinen weniger verwirrend für die Benutzer, so wenige Spieler zu haben, wie Sie absolut brauchen. Du solltest separate Player haben, um einzelne Videos oder Playlists abzuspielen, aber ansonsten brauchst du nur unterschiedliche Player, wenn sie anders gestylt werden oder unterschiedliche Funktionen über Plugins hinzugefügt werden.

Um einen Spieler zu erstellen, machst du einfach einen POST Anfrage an die Player Management API:

    https://players.api.brightcove.com/v2/accounts/account_id/players

Im Hauptteil der Anfrage, schließen Sie die Spielerkonfiguration - Das einzige Erforderliche ist a name:

    {
    "name": "Single video player for blog posts"
    }

Die Antwort gibt dir die Spieler-ID sowie den Einbettungscode in verschiedenen Formen:

    {
    "embed_code": "<iframe src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>",
    "embed_in_page": "http://players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/in_page.embed",
    "id": "de055fa4-4f09-45af-8531-419c6794ad04",
    "preview_embed_code": "<iframe src='//preview-players.brightcove.net/v1/accounts/57838016001/players/de055fa4-4f09-45af-8531-419c6794ad04/preview/embeds/default/master/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>",
    "preview_url": "http://preview-players.brightcove.net/v1/accounts/57838016001/players/de055fa4-4f09-45af-8531-419c6794ad04/preview/embeds/default/master/index.html",
    "url": "http://players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html"
    }

Um die vollständige Spielerkonfiguration zu erhalten, machen Sie eine Anfrage an die /players Endpunkt, aber fügen Sie die Player-ID hinzu, die in der obigen Antwort zurückgegeben wird:

    https://players.api.brightcove.com/v2/accounts/account_id/players/de055fa4-4f09-45af-8531-419c6794ad04

Sie können eine machen PATCH Anforderung an denselben Endpunkt, um die Player-Konfiguration zu aktualisieren.

Sie werden in der obigen Antwort feststellen, dass preview_embed_code und preview_url. Um das Testen neuer Player oder Player-Updates zu ermöglichen, werden neu erstellte oder aktualisierte Player im Vorschaumodus aktiviert, damit Sie sie sehen können, bevor sie auf vorhandene Player umgestellt werden. Um Änderungen in die Produktion zu bringen, müssen Sie veröffentlichen der Spieler mit dieser Anfrage:

    https://players.api.brightcove.com/v2/accounts/account_id/players/de055fa4-4f09-45af-8531-419c6794ad04/publish

Spieler anpassen

Der Brightcove player ist mit Standard-Web-Technologien gebaut: HTML, CSS und JavaScript. Sie können die anpassen player mit den gleichen Technologien. Dies kann auf der Seite erfolgen, auf der die player wird veröffentlicht, aber es wird empfohlen, Ihre Anpassungen dem hinzuzufügen player selbst durch die player KonfigurationAktualisieren des Players über a PATCH Anfrage an die Player Management API wie im vorherigen Abschnitt erläutert.

Sie können dem auch zusätzliche Features und Funktionen hinzufügen player bis JavaScript Pluginsund es gibt eine umfangreiche Player API um Ihnen zu helfen, Ihren Code in die zu integrieren player. Brightcove bietet eine Reihe vorgefertigter Plugins, mit denen beispielsweise Werbung aktiviert, der Endbildschirm angepasst und Überlagerungen hinzugefügt werden können.

Videos veröffentlichen

In dem Spieler erstellen Abschnitt oben haben wir gesehen, dass, wenn Sie das Player - Konfigurationsobjekt mit der Player Management APIDie zurückgegebenen Daten enthalten ein iframe-Tag zum Einbetten des Players in eine HTML-Seite sowie eine URL für das vollständige HTML, wenn Sie den Player direkt in eine Seite einbetten möchten.

Für welches Embedded Sie sich auch entscheiden, müssen Sie ein hinzufügen Video Cloud Video-ID oder Playlist-ID zum Einbettungscode, um dem Player Inhalte hinzuzufügen. Der Iframe-Einbettungscode sieht folgendermaßen aus:

    <iframe
    src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html'
    allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>

An die URL für den Player müssen Sie den Parameter anhängen videoId={}video_id, damit der vollständige Einbettungscode wie folgt aussieht:

    <iframe
    src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html?videoId=4483119716001'
    allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>

Wenn es sich um einen Playlist-Player handelt, verwenden Sie den Parameter playlistId={playlist_id} stattdessen. Die Änderung des In-Page-Einbettungscodes ist ähnlich.

Wenn die Player-Abmessungen nicht in der Player-Konfiguration festgelegt sind, müssen Sie den Player auch durch Hinzufügen von Breite und Höhe in a anpassen style Attribut:

    <iframe
    src='//players.brightcove.net/57838016001/de055fa4-4f09-45af-8531-419c6794ad04_default/index.html?videoId=4483119716001'
    allowfullscreen webkitallowfullscreen mozallowfullscreen
    style=width:640px;height:360px;></iframe>

Analytics-Berichte abrufen

Der Analytics API ermöglicht es Ihnen, Analyseberichte von vielen verschiedenen zu erstellen dimensions. Siehe Maßhilfslinien .

Sie können den Datumsbereich für den Bericht, die zurückzugebenden Messwerte und die Daten angeben JSON, csv, oder xlxs Format

Für Zeiträume innerhalb des letzten Monats können Sie auch detailliert generieren Engagement-Berichte Diese zeigen Ansichten für jeden hundertsten Teil des Videos.

Zusammenfassung der APIs

Hier finden Sie eine Zusammenfassung der APIs, die für die Integration nützlich sind Video Cloud.

OAuth API

Wird zum Erstellen von Clientanmeldeinformationen und Zugriffstoken für den Zugriff auf die anderen APIs verwendet.

Media Management

Ingest Profiles API: Wird verwendet, um benutzerdefinierte Aufnahmeprofile zu erstellen, die die Wiedergabeversionen angeben, die für hinzugefügte Videos erstellt werden sollen Video Cloud
Dynamic Ingest API: Wird zum Hinzufügen von Videos und verwandten Medienelementen verwendet Video Cloud
CMS API: Wird zum Erstellen von Videoobjekten für die Aufnahme und zum Verwalten von Videos und Playlists verwendet

Brightcove Players

Der Brightcove Player: Der player enthält ein JavaScript API zur Interaktion mit dem player zur Laufzeit
Player Management API: Wird zum Erstellen und Konfigurieren von Spielern und zum Einbetten des Player-Einbettungscodes verwendet

Analytics API

Wird verwendet, um Analyseberichte zur Videoleistung zu erhalten

Seiteninhalt

Integrieren Sie Ihr CMS mit Video Cloud

Benutzerfunktionen

Beglaubigung

Client-Anmeldedaten erstellen

Erstellen eines Zugriffstokens

Hinzufügen von Videos

Hinzufügen eines Videoobjekts zu Video Cloud

Das Video einlesen

Dynamische Übermittlungsprofile

Legacy-Ingest-Profile

Hinzufügen von Poster- und Thumbnail-Bildern

Hinzufügen von Textspuren für Untertitel oder Kapitel

Verwalten von Videos

Nach Videos suchen

Ein bestimmtes Video herunterladen und aktualisieren

Wiedergabelisten

Spieler erstellen

Spieler anpassen

Videos veröffentlichen

Analytics-Berichte abrufen

Zusammenfassung der APIs