Support Kontakt Support | Systemstatus Systemstatus

CMS API Benachrichtigungen

In diesem Thema erfahren Sie mehr darüber CMS API Benachrichtigungen. Das CMS API benachrichtigt Sie über Änderungen an den Videos in Ihrem Konto, unabhängig davon, ob sie von einem Kontobenutzer oder der Video Cloud System.

Überblick

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.

Beglaubigung

Wie alle Anfragen an die CMS APIAnmeldungen zum Einrichten oder Auflisten von Benachrichtigungsabonnements müssen mit einer authentifiziert werden Zugangstoken. Die Client-Anmeldeinformationen, die zum Abrufen des Zugriffstokens verwendet werden, müssen über Berechtigungen verfügen video-cloud/notifications/all (CMS->Notifications wenn Sie das benutzen Studio-Benutzeroberfläche um die Berechtigungsnachweise zu erstellen.)

Setup

Sie können bis zu 10-Endpunkte angeben, um Benachrichtigungen zu erhalten, indem Sie a POST Anfrage zu https://cms.api.brightcove.com/v1/accounts/{account_id}/subscriptions und JSON in den Anfragetext wie folgt einfügen:

        {
        "endpoint":"http://solutions.brightcove.com/bcls/di-api/di-callbacks.php",
        "events":["video-change"]
        }
        
        

Benachrichtigungen werden im JSON-Format gesendet. Hier ist ein Beispiel:

        {"timestamp":1423840514446,
        "account_id":"775205503001",
        "event":"video-change",
        "video":"4020894387001",
        "version":26}
        
        

Benachrichtigungsfelder

Artikel Beschreibung
timestamp Zeitpunkt, zu dem das Ereignis aufgetreten ist Epoch Millisekunden
account_id Sie einem Video Cloud Konto-ID
event die Art des Ereignisses - das wird derzeit immer sein video-change
video die Video-ID
version die Version des Videos - jeder Satz von Änderungsereignissen erhöht die Videoversion - zum Beispiel würde die Erstellung eines neuen Satzes von Wiedergabeversionen eine Reihe von Änderungsereignissen darstellen

Anfragen zum Erstellen eines Abonnements erhalten ein HTTP 422 Fehlerantwort für die folgenden Bedingungen:

  • Unser endpoint or events Feld fehlt im Anfragetext
  • Unser events Feldwert ist keine Liste (Array)
  • Das definierte Abonnement existiert bereits
  • Sie haben bereits 10-Abonnements für dieses Ereignis

Benachrichtigungsfehler

Das Benachrichtigungssystem behandelt alle 4xx or 5xx Rückgabe vom Kundenserver als wiederholbarer 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

Wenn in Ihrem Unternehmen strikte Richtlinien bezüglich der Quellen des eingehenden Datenverkehrs durch Ihre Firewall gelten, lassen wir die IP-Adressen von AWS us-east-1 / Virginia zu. Dies kann sich ändern, daher sollten alle AWS-IP-Adressen in die Whitelist aufgenommen werden. Sehen http://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html .

Endpunkt für Benachrichtigungsabonnements

        /accounts/{account_id}/subscriptions
        
        

Erstellen Sie ein neues Abonnement

Um ein neues Abonnement zu erstellen, reichen Sie ein POST Anfrage mit einem Anforderungshauptteil einschließlich des Endpunkts, an den Benachrichtigungen an und gesendet werden sollen video-change als das einzige Element in einem events Array:

        { "endpoint": "http://solutions.brightcove.com:9002", "events": [ "video-change" ] }
        
        

Erhalten Sie eine Liste Ihrer Abonnements

Um eine Liste aller Ihrer Abonnements zu erhalten, senden Sie eine GET Anfrage an den Abonnement-Endpunkt.

Abrufen oder Löschen eines einzelnen Abonnements

Verwenden Sie den folgenden Endpunkt, um ein einzelnes Abonnement zu erhalten oder zu löschen:

Endpunkt

        /accounts/{account_id}/subscriptions/{subscription_id}
        
        

A GET Anfrage wird das Abonnement abrufen. EIN DELETE Anfrage wird das Abonnement löschen. Sie können ein Abonnement zu diesem Zeitpunkt nicht aktualisieren. Wenn Sie ein Abonnement ändern möchten, müssen Sie es löschen und ein neues erstellen.

Was löst Benachrichtigungen aus?

video-change Ereignisse werden durch eine Änderung der Video-Metadaten ausgelöst. Dies beinhaltet alle Änderungen am Video, die in Studio oder über ein CMS API Schreibmethode. Es gibt auch Systemereignisse, die ausgelöst werden video-change Veranstaltungen.

Zu den Änderungen, die ein Ereignis auslösen, gehören:

  • Ein Video wird erstellt
  • Die Aufnahme von Video- oder Asset-Dateien beginnt
  • Die Aufnahme von Video- oder Asset-Dateien ist abgeschlossen
  • Die Codierung einer neuen Wiedergabe wird beendet
  • Ein Posterbild wird erstellt
  • Ein Miniaturbild wird erstellt
  • Ein Video wird gelöscht
  • Video-Metadaten werden geändert (vom System oder einem Benutzer)

Wichtige Informationen

Das erneute Transcodieren eines Videos löst keine video-change Ereignis, es sei denn, der resultierende Renditionssatz ist anders.

Es gibt Systemereignisse, die auftreten, nachdem ein Video gelöscht wurde, sodass Sie nach dem Löschen Benachrichtigungen über ein Video erhalten.

Was wird nicht triggern a video-change Ereignis ist eine Änderung an einem Videoasset, die die Videometadaten nicht ändert. Wenn Sie beispielsweise eine Remote-Text-Track-Datei oder ein Remote-Text-Bild ersetzen, bleibt die in den Video-Metadaten aufgezeichnete URL jedoch unverändert video-change Ereignis wird auftreten, und keine Benachrichtigung wird gesendet.


Seite zuletzt aktualisiert am 12. Juni 2020