Support Kontaktieren Sie Support | Systemstatus Systemstatus
Inhalt der Seite

    CMS API Benachrichtigungen

    In diesem Thema erfahren Sie mehr über CMS API Benachrichtigungen. Der CMS API bietet Benachrichtigungen über Änderungen an den Videos in Ihrem Konto, unabhängig davon, ob sie von einem Kontobenutzer oder dem Video Cloud-System vorgenommen wurden.

    Übersicht

    Sie können Benachrichtigungen erhalten, wenn video-change Ereignisse in Ihrer Videobibliothek auftreten. Benachrichtigungen werden an die von Ihnen angegebene URL gesendet, die auf eine verarbeitungsfähige Anwendung verweisen soll HTTP POST Anfragen.

    Authentifizierung

    Wie alle Anfragen an die CMS-API müssen Anfragen zur Einrichtung oder zum Einrichten von Benachrichtigungsabonnements mit einem Zugriffstokenauthentifiziert werden. Die Client-Anmeldeinformationen, die zum Abrufen des Zugriffstoken verwendet werden, müssen über Berechtigungen verfügen video-cloud/notifications/all (CMS->Notifications wenn Sie die Studio-Benutzeroberfläche zum Erstellen der Anmeldeinformationen verwenden).

    Setup

    Sie können bis zu 10 Endpunkte angeben, um Benachrichtigungen zu erhalten, indem Sie eine POST Anfrage an JSON stellen https://cms.api.brightcove.com/v1/accounts/{account_id}/subscriptions und in den Anforderungsnachrichten wie folgt einbeziehen:

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

    Benachrichtigungen werden im JSON-Format gesendet. Beispiel:

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

    Felder für Benachrichtigungen

    Element Beschreibung
    timestamp Uhrzeit, zu der das Ereignis in Epoch Millisekunden aufgetreten ist
    account_id die Video Cloud Konto-ID
    event die Art der Veranstaltung - derzeit wird dies 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 zur Erstellung eines Abonnements erhalten eine HTTP 422 Fehlerantwort für die folgenden Bedingungen:

    • Das endpoint oder events Feld fehlt im Anforderungshauptteil
    • Der events Feldwert ist keine Liste (Array)
    • Das definierte Abonnement existiert bereits
    • Sie haben bereits 10 Abonnements für diese Veranstaltung

    Fehler bei Benachrichtigungen

    Das Benachrichtigungssystem behandelt einen 4xx oder eine 5xx Rücksendung vom Kundenserver als einen zurückziehbaren Ausfall. Fehlgeschlagene Rückrufe werden bis zu 20 Mal wiederholt, mit einer exponentiell steigenden Verzögerung zwischen nachfolgenden Rückrufen. Die ersten paar Wiederholungen werden innerhalb von Minuten nach dem ersten Rückrufversuch durchgeführt. Wenn der Rückruf weiterhin fehlschlägt und wir bis zur 20. Wiederholung übergehen, wird die Wiederholungsverzögerung einige Tage betragen.

    Firewalls

    Falls Ihr Unternehmen eine strenge Richtlinie in Bezug auf eingehenden Datenverkehr über Ihre Firewall hat, erlauben wir die AWS US-East-1/Virginia-IPs. Dies kann sich ändern, daher sollten alle AWS-IPs auf die Whitelist gesetzt werden. Weitere Informationen finden Sie unter 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, senden Sie eine POST Anfrage mit einem Anforderungstext, einschließlich des Endpunkts, an den Benachrichtigungen gesendet werden soll, und video-change als einzelnes Element in einem events Array:

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

    Holen Sie sich eine Liste Ihrer Abonnements

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

    Ein einziges Abonnement abrufen oder löschen

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

    Endpunkt

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

    Eine GET Anfrage ruft das Abonnement ab. Eine DELETE Anfrage löscht das Abonnement. Sie können derzeit kein Abonnement 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 Änderungen der Video-Metadaten ausgelöst. Dies schließt alle Änderungen am Video ein, das in Studio oder über eine CMS API Schreibmethode vorgenommen wurde. Es gibt auch Systemereignisse, die video-change Ereignisse auslösen.

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

    • Ein Video wird erstellt
    • Die Aufnahme von Video oder Asset-Datei beginnt
    • Die Aufnahme von Video oder Asset-Datei ist abgeschlossen
    • Die Kodierung einer neuen Formatvariante endet
    • Ein Plakatbild wird erstellt
    • Ein Thumbnail-Bild wird erstellt
    • Ein Video wird gelöscht
    • Video-Metadaten werden geändert (vom System oder einem Benutzer)

    Hinweise

    Die erneute Programmierung eines Videos löst kein video-change Ereignis aus, es sei denn, der resultierende Formatvariantensatz ist anders.

    Es gibt Systemereignisse, die nach dem Löschen eines Videos auftreten, sodass Sie nach dem Löschen Benachrichtigungen über ein Video erhalten.

    Was wird nicht auslösen a video-change Ereignis ist eine Änderung an einem Video-Asset, bei der die Video-Metadaten nicht geändert werden. Wenn Sie beispielsweise eine Remote-Text-Track-Datei oder ein Remote-Text-Track-Bild ersetzen, die in den Video-Metadaten aufgezeichnete URL jedoch unverändert bleibt, wird kein video-change Ereignis eintreten und es wird keine Benachrichtigung gesendet.


    Seite zuletzt aktualisiert am 29 Sep. 2020