CMS-API-Benachrichtigungen

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

Überblick

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 zum Einrichten oder Auflisten von Benachrichtigungsabonnements mit einem authentifiziert werden Zugangstoken. Die zum Abrufen des Zugriffstokens verwendeten Clientanmeldeinformationen müssen über Berechtigungen für verfügen video-cloud/notifications/all ((CMS->Notifications wenn Sie die verwenden Studio-Benutzeroberfläche um die Anmeldeinformationen zu erstellen.)

Einrichtung

Um ein neues Abonnement zu erstellen, senden Sie eine POST Anfrage https://cms.api.brightcove.com/v1/accounts/{account_id}/subscriptions mit einem Anforderungstext, der den Endpunkt enthält, an den Benachrichtigungen gesendet werden sollen, video-change oder master-video-change als einzelnes Element in einem Ereignis-Array. Sie können bis zu 10 Endpunkte pro Ereignis angeben, die Benachrichtigungen erhalten sollen.

Die verfügbaren Ereignisse für beziehen video-change sich auf Ihre Videobibliothek, und jetzt beziehen master-video-change sich die Ereignisse für auf Änderungen an den Assets eines Master-Videos mit dynamischer Bereitstellung, die sich letztendlich in Ihrem geteilten Video widerspiegeln.

Für video-change Veranstaltungen

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

Für master-video-change Veranstaltungen

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

Benachrichtigungen werden im JSON-Format gesendet. Hier ist ein Beispiel für video-change Ereignisse:

{
  "timestamp":1423840514446, 
  "account_id":"775205503001", 
  "event":"video-change", 
  "video":"4020894387001", 
  "version":26,
  “action”:”UPDATE”,
  “updated_by”:{ "email": "string", "id": "string", "type": "user" }
}

Und ein Beispiel dafür master-video-change sieht so aus:

{
  "timestamp":1423840514446,
  "account_id":"775205503001",
  "event":"video-change",
  "video":"4020894387001", 
  "version":26, 
  "action":"UPDATE", 
  "updated_by":{ "email": "string", "id": "string", "type": "user" },
  "master_account_id":"784205904003",
  "master_video_id":"6200985429005"
}

Benachrichtigungsfelder

Artikel Beschreibung
timestamp Zeitpunkt, zu dem das Ereignis eingetreten ist, in Epoch Millisekunden
account_id das Video Cloud Konto-ID
master_account_id die Only for master-video-change events: The id of the master video who made the update in the assets shared with the affiliate video.
master_video_id die Only for master-video-change events: The id of the Video Cloud master account for the master video.
event die Art der Veranstaltung - aktuell 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 Wiedergaben einen Satz von Änderungsereignissen darstellen
action[1-1] die durchgeführte Aktion - eine der folgenden Möglichkeiten:
  • UPDATE- ein Asset wurde aktualisiert
  • CREATE- ein Asset wurde erstellt
  • TRIGGERED_MANUAL- eine Benachrichtigung wurde von einer internen Brightcove-Anwendung ausgelöst
  • DELETE- ein Asset wurde gelöscht
    		•
    updated_by[1-1] ein Objekt, das Informationen darüber enthält, wer die Aktion durchgeführt hat, falls verfügbar; die Objekteigenschaften sind:
  • email- die E-Mail-Adresse des Benutzers
  • id- die Video Cloud-System-ID für den Benutzer
  • type- die Art des Updates:
    • user- ein Benutzer in Studio
    • api-key- ein Benutzer über die API
    • internal- ein Brightcove-System oder ein Brightcove-Benutzer
    		•

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

    • Die endpoint oder events Feld fehlt im Anfragetext
    • Die events Feldwert ist keine Liste (Array)
    • Das definierte Abonnement ist bereits vorhanden
    • Du hast bereits 10 Abonnements für diese Veranstaltung

    Benachrichtigungsfehler

    Das Benachrichtigungssystem behandelt alle 4xx oder 5xx Rückkehr vom Kundenserver als wiederholbarer Fehler. Fehlgeschlagene Rückrufe werden bis zu 20 Mal wiederholt, wobei die Verzögerung zwischen nachfolgenden Rückrufen exponentiell ansteigt. Die ersten Versuche werden innerhalb von Minuten nach dem ersten Rückrufversuch durchgeführt. Wenn der Rückruf weiterhin fehlschlägt und wir bis zum 20. Wiederholungsversuch kommen, wird die Wiederholungsverzögerung einige Tage betragen.

    Firewalls

    Falls Ihre Organisation eine strenge Richtlinie bezüglich der Quellen des eingehenden Datenverkehrs durch 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. Sehen https://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html für mehr Informationen.

    Endpunkt für Benachrichtigungsabonnements

            /accounts/{account_id}/subscriptions

    Erhalten Sie eine Liste Ihrer Abonnements

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

    /accounts/{account_id}/subscriptions

    Holen oder löschen Sie ein einzelnes Abonnement

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

    Endpunkt

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

    EIN GET request ruft das Abonnement ab. EIN DELETE Anfrage löscht das Abonnement. Sie können ein Abonnement derzeit 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 jede Änderung der Video-Metadaten ausgelöst. Dies schließt alle Änderungen am Video ein, die in Studio oder über a vorgenommen wurden 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
    • Aufnahme der Video- oder Asset-Datei beginnt
    • Aufnahme der Video- oder Asset-Datei ist abgeschlossen
    • Codierung einer neuen Wiedergabe beendet
    • Ein Posterbild wird erstellt
    • Ein Miniaturbild wird erstellt
    • Ein Video wird aktiviert oder deaktiviert
    • Ein Video wurde gelöscht
    • Video-Metadaten werden geändert (vom System oder einem Benutzer)
    • master-video-change Ereignisse werden durch Aktualisierungen der Assets eines Mastervideos ausgelöst, sodass sie nur zum Teilen verfügbar sind.

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

      • Eingespielte Elemente werden dem Master-Video hinzugefügt
      • Eingespielte Elemente werden im Master-Video ersetzt/neu kodiert

    Hinweise

    Durch die erneute Transkodierung eines Videos wird kein video-change Ereignis ausgelöst, es sei denn, das resultierende Wiedergabe-Set ist anders.

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

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

    Das Löschen von Assets in einem Mastervideo löst kein master-video-change Ereignis aus. Wenn Elemente aus einem Video entfernt werden, liegt das daran, dass das Video gelöscht wird, und die Freigabe regelt bereits den Löschvorgang für Partnerschaftsvideos.