Support Kontakt Support | Systemstatus Systemstatus
Seiteninhalt

    Überblick: CMS API

    In diesem Thema erhalten Sie einen Überblick über das CMS APIdem „Vermischten Geschmack“. Seine CMS API bietet uncached Lesezugriff auf die Daten. Dies ist wichtig für zeitkritische Publishing-Workflows, da Sie Änderungen an Videos und Playlists mithilfe von CMS API und lesen Sie schnell die Daten, um zu überprüfen, ob das korrekt ist.

    API-Referenz

    Siehe auch die API-Referenz.

    Allgemeine Information

    Basis-URL

    Die Basis-URL für die CMS API ist:

            https://cms.api.brightcove.com/v1

    Kontopfad

    In allen Fällen werden Anfragen für eine bestimmte Anfrage gestellt Video Cloud Konto. Also, Sie werden immer den Begriff hinzufügen accounts gefolgt von Ihrer Konto-ID zur Basis-URL:

            https://cms.api.brightcove.com/v1/accounts/{account_id}

    Beglaubigung

    Authentifizierung für Anfragen erfordert ein Authorization header :

            Authorization: Bearer {access_token}

    Das access_token ist ein temporäres OAuth2-Zugriffstoken, das von der Brightcove OAuth Bedienung. Weitere Einzelheiten finden Sie in der Brightcove OAuth Übersicht.

    Der einfachste Weg, um Client-Anmeldeinformationen zu erstellen, sind die Brightcove Studio-Administrationsseiten. Detaillierte Anweisungen finden Sie unter API-Authentifizierungsdaten verwalten

    Operations

    Wenn Sie Client-Anmeldeinformationen anfordern, müssen Sie den Typ des Kontozugriffs oder die gewünschten Vorgänge angeben. Im Folgenden finden Sie eine Liste der derzeit unterstützten Vorgänge für CMS API :

    • Videodaten:

      video-cloud/video/read
      video-cloud/video/create
      video-cloud/video/update
      video-cloud/video/delete
      or
      video-cloud/video/all
      video-cloud/video/assets/delete (Wird nur benötigt, wenn Sie digitale Master löschen möchten - beachten Sie, dass Sie kann keine Erhalten Sie diese Berechtigung, wenn Sie Anmeldeinformationen in Studio erstellen. Es muss durch die gemacht werden OAuth API oder Beispiel-App, erstellt von Brightcove Learning Services.)

    • Playlist-Daten:

      video-cloud/playlist/read
      video-cloud/playlist/create
      video-cloud/playlist/update
      video-cloud/playlist/delete
      or
      video-cloud/playlist/all

    • Hinweise:

    Ratenbegrenzung

    Dieses CMS API bietet uncached Lesezugriff auf die Daten. Dies ist wichtig für zeitkritische Publishing-Workflows, da Sie Änderungen an Videos und Playlists mithilfe von CMS API und lesen Sie schnell die Daten, um zu überprüfen, ob das korrekt ist.

    Das CMS API ist nicht geeignet für die Nutzung von High-Scale-Runtime (z. B. Zugriff auf Videos auf einer öffentlichen Website mit hohem Datenverkehr). Für Anwendungen mit hohem Datenverkehr müssen Sie eine zwischengespeicherte Schnittstelle verwenden, z Playback API , Gallery, Players oder die Native SDKs.

    Um die Leistung des zu gewährleisten Video Cloud System, nicht mehr als 20 gleichzeitige Aufrufe an die CMS API sind pro Konto erlaubt. Zugriffsfrequenz sollte weniger als 10-Anforderungen pro Sekunde sein.

    Wenn mehrere Anwendungen in die integriert werden CMS API Für ein Konto sollten diese Anwendungen Backoff- und Wiederholungslogik haben, um Instanzen zu behandeln, bei denen Parallelitätsgrenzen oder Ratengrenzen erreicht werden.

    Wenn entweder die Rate oder die Nebenläufigkeitsgrenze überschritten wird, a 429 - TOO_MANY_REQUESTS Fehler wird zurückgegeben.

    Referenz-ID-Konflikte

    Um die Eindeutigkeit von Referenz - IDs zu gewährleisten, muss der CMS API sperrt die ID bis zu 3 Minuten nach einer beliebigen Operation des Videos, dem sie zugewiesen ist. Dies kann dazu führen, dass 409-Fehler zurückgegeben werden, wenn Sie versuchen, eine Anforderung zu wiederholen, die zu schnell fehlschlägt, oder wenn Sie versuchen, eine Referenz-ID zu früh wieder zu verwenden, nachdem das zuvor zugewiesene Video gelöscht wurde. Siehe die Fehlermeldungsreferenz für weitere Informationen kontaktieren.

    Video-Nutzungsbeschränkung

    Es gibt ein Limit für 1,000-Assets pro Video. Zu den Assets gehören Wiedergabeversionen, Audiospuren, Textspuren und Bilder sowie der digitale Master. Renditions und Bilder ergeben selten mehr als 10-15-Assets. Selbst wenn Sie separate Audiotracks und Texttracks für 150-Sprachen hätten, hätten Sie immer noch weniger als 350-Assets.

    Hinweise zur Verwendung

    Methoden

    Derzeit unterstützt die API folgende Anfragetypen:

    • GET
    • POST
    • PATCH
    • PUT
    • DELETE

    Parameter

    Beachten Sie, dass alle Parameter sind fakultativ. Sofern nicht anders angegeben, gelten sie für GET Anfragen nach Videos und Playlists

    GET Anfrageparameter
    Parameter Beschreibung
    q Abfragezeichenfolge für Suchen - siehe Suchsyntax zu weiteren Informationen und Erklärungen
    limit Anzahl der zurückzugebenden Videos - muss eine Ganzzahl zwischen 1 und 100 sein. Standard: 20
    offset Anzahl der zu überspringenden Videos (für Paging-Ergebnisse) Muss eine positive ganze Zahl sein. Standard: 0
    sort Eine Zeichenfolge, die das Feld angibt, nach dem sortiert werden soll. Beginnen mit - absteigend sortieren. Wenn ein Wert für q wird zur Verfügung gestellt, dann ist die Standardsortierung nach "score" (Relevanz der Suchergebnisse auf die ursprüngliche Anfrage). Wenn kein Wert für q wird bereitgestellt, dann ist die Standardsortierung updated_at absteigend. Die folgenden Felder sind für die Sortierung gültig: name, reference_id, created_at, published_at, updated_at, schedule_starts_at, schedule_ends_at, state, plays_total, und plays_trailing_week

    Brightcove's CMS API bietet eine programmatische Möglichkeit, nach Videos in Ihrem Browser zu suchen Video Cloud Bibliothek.

    Um grundlegende und komplexe Suchen an Ihren Videodaten durchzuführen, verwenden Sie die q Parameter:

            https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q={search terms}

    Weitere Informationen zur Suche nach Videos finden Sie unter Search Videos Dokument.

    Bei Wiedergabelisten sind die unterstützten Werte für den Suchbegriff kürzer. Sie können derzeit nach suchen type, name, description, und reference_id. Hier sind einige Beispielgültige Suchen:

    • q=type:EXPLICIT
    • q=type:ACTIVATED_OLDEST_TO_NEWEST
    • q=type:ALPHABETICAL
    • q=bears+otters (Name, Beschreibung oder Referenz-ID müssen entweder "Bären" oder "Otter" enthalten)
    • q=%2Bname:bears+type:EXPLICIT (Name muss "Bären" enthalten)

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

    Paging-Ergebnisse

    Verwenden Sie das limit Parameter, um anzugeben, wie viele Elemente bei einer Anfrage zurückgegeben werden sollen - bis zu 100. Sie können dann die offset Parameter zum Durchblättern von Ergebnismengen, die größer sind als der limitdem „Vermischten Geschmack“. Seine offset ist die Anzahl der zu überspringenden Elemente.

    Die folgende Suche gibt beispielsweise die Videos 51-75 der gesamten Ergebnismenge zurück, vorausgesetzt, dass die Gesamtergebnismenge mindestens 75-Videos enthält:

            /videos?q=updated_at:2014-01-01..2014-06-30&limit=25&offset=50

    Das limit und offset Parameter können sowohl für Videos als auch für Wiedergabelisten verwendet werden.

    Paging-Best Practice

    Weil es möglicherweise gleichzeitige Modifikationsoperationen gibt, die mit der CMS APIEs wird empfohlen, die folgenden Schritte auszuführen, wenn Sie die Ergebnismenge durchblättern:

    1. Mach ein count fordern Sie an, die Gesamtzahl der Videos in Ihrem Ergebnissatz zu erhalten.
            /accounts/578380111111/counts/videos?q=tags:nature
    2. Verwenden Sie das limit und offset Parameter zum Zurückgeben von Datengruppen aus Ihrer Ergebnismenge.
            /accounts/578380111111/videos?q=tags:nature&limit=20&offset=50
    3. Beachten Sie, dass einige Seiten möglicherweise weniger als 20-Videos enthalten. Sie werden wissen, dass Sie das Ende der Ergebnismenge erreicht haben, wenn Sie so viele Videos wie in der ersten Frage angefordert haben count anfordern.

    Fassen Sie die Seiten so lange zusammen, bis Sie eine Anzahl von Videos erhalten, die dem Original entspricht count Anfrage, da diese Zahl auf der Seite der Überschätzung irren sollte. Nachfragen:

          count / page-size + 1 page

    Sortieren von Video-Ergebnissen

    Verwenden Sie den Parameter sort=field_name Um festzulegen, wie die Ergebnisse sortiert werden sollen, können Sie sowohl Videos als auch Wiedergabelisten sortieren. Sie können nach folgenden Videofeldern sortieren: [1-1]

    • name
    • reference_id
    • created_at
    • published_at
    • updated_at
    • schedule_starts_at (Anmerkung: Dies ist die sortieren Feld - das Suchfeld ist schedule.starts_at )
    • schedule_ends_at (Anmerkung: Dies ist die sortieren Feld - das Suchfeld ist schedule.ends_at )
    • state
    • plays_total [1-2]
    • plays_trailing_week [1-2]

    Einschränkungen

    • [1-1] Wenn Sie für einen Video-Suchanruf keinen Sortierwert angeben, werden die Ergebnisse nach Relevanz sortiert. Wenn Sie keinen Sortierwert für a bereitstellen GET Videos aufrufen, werden die Ergebnisse sortiert nach updated_at absteigend.
    • [1-2] Sie können sortieren plays_total or plays_trailing_week, aber diese Felder sind nicht in den Ergebnissen enthalten

    Playlist-Ergebnisse sortieren

    Sie können Wiedergabelisten in den folgenden Feldern sortieren:

    • name
    • updated_at (Default)

    Alle Videos und große Datensätze

    Wenn Sie alle Videos in Ihrem Konto oder eine große Anzahl von Videos abrufen, müssen Sie Folgendes beachten:

    1. Sie könnten versucht sein, das größte erlaubte zu verwenden limit (100), aber es ist besser, Videos in Stapeln von 25 oder weniger abzurufen, um die Möglichkeit zu minimieren, dass API-Anfragen zeitlich begrenzt werden
    2. Wenn Sie große Datensätze durchsuchen, ist es möglich, dass die Videodaten während der Operation aktualisiert werden, was dazu führen kann, dass sich die Elemente in den Antworten verschieben:
      • Möglicherweise sehen Sie ein Element auf mehreren Seiten wiederholt
      • Ein Gegenstand könnte verfehlt werden, da er zu einer vorherigen Antwortgruppe verschoben wurde

      Um die erste Möglichkeit zu berücksichtigen, sollte Ihre App die gesamte Objektliste entfernen, nachdem Sie alle Videos abgerufen haben. Um die zweite Möglichkeit zu behandeln, müssen Sie die Gesamtzahl der abgerufenen Elemente (nach der Deduplizierung) mit der erwarteten Anzahl vergleichen und dann die Anforderungen erneut ausführen, wobei die Ergebnisse nach last_modified_date (absteigend) sortiert werden. Dies sollte nicht erforderlich sein rufen Sie mehr als einen Stapel ab, um verpasste Artikel abzurufen.

    3. Sie können die Wahrscheinlichkeit der Szenarien im vorherigen Element verringern, indem Sie die zurückgegebenen Ergebnisse entsprechend sortieren. Die Standardsortierung nach Relevanz Für Suchvorgänge wird ein komplexer Algorithmus verwendet, der Kombinationen aus Schlüsselwörtern, Tags und benutzerdefinierten Feldwerten darstellt. Wenn Sie nach Videos suchen, die auf mehreren Keywords, Tags und / oder benutzerdefinierten Feldern basieren, ist die Sortierung nach Relevanz genau das Richtige. Wenn Sie jedoch nur versuchen, alle oder eine große Menge Ihrer Videos abzurufen, legen Sie die Option sort Parameter explizit gibt Ihnen mehr Kontrolle über die Reihenfolge der zurückgegebenen Elemente.

    Videooperationen

    Videooperationen umfassen:

    • Erhalten Sie eine Anzahl von Videos oder Suchergebnissen
    • Hol dir alle Videos
    • Hol dir ein oder mehrere Videos nach ID oder Referenz-ID
    • Erstellen, abrufen, aktualisieren und löschen Sie Videos
    • Nach Videos suchen
    • Erhalten Sie Videoquellen, Bilder und die digitalen Master-Informationen
    • Hol dir die Playlists, zu denen ein Video gehört
    • Entferne das Video aus allen Playlists

    Details zu den Videooperationen finden Sie in der API-Referenz.

    Playlist-Operationen

    Playlist-Operationen umfassen:

    • Erhalte eine Anzahl von Playlists
    • Hol dir alle Playlists
    • Erstellen, aktualisieren und löschen Sie Wiedergabelisten
    • Erhalte eine Anzahl von Videos in einer Playlist
    • Hol dir die Videos in einer Playlist

    Details zu den Playlist-Funktionen finden Sie in der API-Referenz.

    Aktiva

    Mit Asset-Operationen können Sie Assets verwalten, einschließlich Darstellungen, Manifesten, Bildern und Textspuren. Um Assets einzutauschen, müssen Sie die Dynamic Ingest APIdem „Vermischten Geschmack“. Seine POST und PATCH Operationen für die CMS API /assets kann zum Hinzufügen und Aktualisieren verwendet werden Remote-Assets. CMS API GET-Operationen funktionieren für beide aufgenommene und entfernte Anlagen.

    • Hinzufügen, Aktualisieren oder Löschen von Darstellungen
    • Fügen Sie Metadaten für den digitalen Master hinzu, aktualisieren oder löschen Sie sie
    • Hinzufügen, Aktualisieren oder Löschen von Manifesten für segmentierte Videotypen wie HLS
    • Hinzufügen, Aktualisieren oder Entfernen von Poster- und Miniaturbildern
    • Hinzufügen, Aktualisieren oder Entfernen von WebVTT-Textspuren oder DFXP-Bildunterschriften

    Details zu den Asset-Operationen finden Sie in der API-Referenz.

    Benutzerdefinierte Feldoperationen

    Derzeit gibt es eine benutzerdefinierte Feldoperation:

    • Erhalten Sie alle benutzerdefinierten Felder für ein Konto

    Details zu den benutzerdefinierten Feldoperationen finden Sie in der API-Referenz.

    Ordneroperationen

    Ordneroperationen ermöglichen Ihnen:

    • Holen Sie sich eine Liste von Ordnern
    • Erstellen, aktualisieren und löschen Sie Ordner
    • Erhalte eine Liste von Videos in einem Ordner
    • Fügen Sie ein Video zu einem Ordner hinzu
    • Entferne ein Video aus einem Ordner

    Details zu den Ordneroperationen finden Sie in der API-Referenz.

    Benachrichtigungen

    Sie können Benachrichtigungen erhalten, wenn video_change Ereignisse treten in Ihrer Videobibliothek auf. Benachrichtigungen werden an die von Ihnen angegebene URL gesendet, die auf eine Anwendung verweist, die verarbeitet werden kann HTTP POST Anfragen.

    Benachrichtigungsfehler

    Das Benachrichtigungssystem behandelt jede 4xx- oder 5xx-Rückgabe vom Kundenserver als wiederholbaren Fehler. Fehlgeschlagene Rückrufe werden bis zu 20-Zeiten wiederholt, mit einer exponentiell zunehmenden Verzögerung zwischen nachfolgenden Rückrufen. Die ersten Versuche werden innerhalb von Minuten nach dem ersten Rückrufversuch durchgeführt. Wenn der Rückruf weiterhin fehlschlägt und wir den vollständigen 20th-Wiederholungsversuch durchführen, beträgt die Wiederholungsverzögerung ein paar Tage.

    Firewalls

    Falls Ihre Organisation eine strikte Richtlinie hinsichtlich der Quellen des eingehenden Datenverkehrs durch Ihre Firewall hat, erlauben wir alle AWS East Region IPs. Dies kann sich ändern. Daher sollten alle AWS-IPs auf die Whitelist gesetzt werden. Sehen https://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html .

    Benachrichtigungsvorgänge

    Die derzeit verfügbaren Vorgänge für Benachrichtigungen sind:

    • Abonnements erstellen
    • Erhalten Sie ein oder alle Abonnements
    • Löschen Sie ein Abonnement

    Details zu den Benachrichtigungsoperationen finden Sie in der API-Referenz.


    Seite zuletzt aktualisiert am 28