Verwenden von Authentifizierungs-APIs

Einleitung

Brightcove-Wiedergabeeinschränkungen bieten ein zusätzliches Maß an Sicherheit, wenn Dynamic Delivery mit DRM-geschützten oder HTTP Live Streaming Encryption (HLSe)-Inhalten verwendet wird.

Wenn Sie mit dieser Funktion nicht vertraut sind, lesen Sie die Übersicht: Dokument „Brightcove Playback Restrictions“

Hier sind die verfügbaren APIs für die Verwaltung des Schlüssel-/Lizenzschutzes:

Öffentlichen Schlüssel registrieren
Blacklist-Token
Ein Konto prüfen

Öffentlichen Schlüssel registrieren

Sie besitzen den privaten Schlüssel und verwenden ihn, um signierte Token zu generieren. Sie geben den öffentlichen Schlüssel an Brightcove weiter, um Ihre Token zu überprüfen. Mit der Schlüssel-API können Sie Ihren öffentlichen Schlüssel bei Brightcove registrieren.

Schlüssel-API

Die Schlüssel-API wird verwendet, um Ihre öffentlichen Schlüssel mit Brightcove zu verwalten.

Basis-URL

Die Basis-URL für die API lautet:

https://playback-auth.api.brightcove.com

Account-Pfad

In allen Fällen werden Anfragen für ein bestimmtes Video Cloud-Konto gestellt. Sie fügen also immer den Begriff Konten gefolgt von Ihrer Konto-ID zur Basis-URL hinzu:

https://playback-auth.api.brightcove.com/v1/accounts/{accountID}

Autorisierung

Ein Zugriffstoken für Anfragen ist erforderlich und muss im Autorisierungsheader vorhanden sein።

Authorization: Bearer {access_token}

Das Zugriffstoken ist ein temporäres OAuth2-Zugriffstoken, das vom Brightcove OAuth-Dienst abgerufen werden muss. Ausführliche Informationen zum Abrufen von Client-Anmeldeinformationen und deren Verwendung zum Abrufen von Zugriffstoken finden Sie im Übersicht über Brightcove OAuth.

Berechtigungen

Anfragen an die Schlüssel-API müssen gestellt werden von Kundenanmeldeinformationen mit folgenden Berechtigungen:

video-cloud/playback-auth/key/read
video-cloud/playback-auth/key/write

Schlüssel verwalten

Die Key API unterstützt die folgenden Anfragen:

Registrieren Sie einen neuen Schlüssel:

Geben Sie den Wert Ihres öffentlichen Schlüssels in den API-Anfragetext ein. Den Schlüssel findest du im public_key.txt Datei.

API-Anfrage

POST /v1/accounts/{accountID}/keys
    Content-Type: application/json
    Body: {"value": "MFkwEwYHKoZIzj0CAQYIKoZIzj...MyeQviqploA=="}

Verwendung von Curl

curl -X BEITRAG\
    -H "Inhaltstyp: application / json" \\
    -H "Autorisierung: Inhaber {access_token} "\\
    -d '{"value": "{your_public_key_value}"}' \\
  https://playback-auth.api.brightcove.com/v1/accounts/{accountID}/keys

API-Antwort

{
    "id": "{your_public_key_id}",
    "type": "public",
    "algorithm": "rsa",
    "value": "{your_public_key_value}",
    "createdAt": "2020-01-03T20:30:36.488Z"
  }

Listenschlüssel:

Rufen Sie eine Liste der öffentlichen Schlüssel in Ihrem Konto ab.

GET /v1/accounts/{accountID}/keys

Holen Sie sich einen Schlüssel:

Rufen Sie die Details für einen öffentlichen Schlüssel in Ihrem Konto ab.

GET /v1/accounts/{accountID}/keys/{key_Id}

Einen Schlüssel löschen:

Löschen Sie einen öffentlichen Schlüssel in Ihrem Konto.

DELETE /v1/accounts/{accountID}/keys/{key_Id}

Blacklist-Token

Ein Token, das auf die schwarze Liste gesetzt wurde, wird für Lizenzanfragen nicht als gültig angesehen, selbst wenn es ansonsten genehmigt worden wäre. Kunden können bis zu 100 Token auf die schwarze Liste setzen. Wenn bereits 100 Token auf der schwarzen Liste stehen, muss ein Kunde einen oder mehrere Token löschen, um Platz für weitere Einträge zu schaffen.

Blacklist-API

Die Blacklist-API wird verwendet, um Ihre Token zu verwalten, die auf der schwarzen Liste stehen und für Lizenzanfragen als nicht gültig gelten.

Basis-URL

Die Basis-URL für die Blacklist-API lautet:

https://playback-auth.api.brightcove.com

Account-Pfad

In allen Fällen werden Anfragen für ein bestimmtes Video Cloud-Konto gestellt. Sie fügen also immer den Begriff Konten gefolgt von Ihrer Konto-ID zur Basis-URL hinzu:

https://playback-auth.api.brightcove.com/v1/accounts/{accountID}/blacklist

Autorisierung

Ein Zugriffstoken für Anfragen ist erforderlich und muss im Autorisierungsheader vorhanden sein።

Authorization:  Bearer  {access_token}

Das Zugriffstoken ist ein temporäres OAuth2-Zugriffstoken, das vom Brightcove OAuth-Dienst abgerufen werden muss. Ausführliche Informationen zum Abrufen von Client-Anmeldeinformationen und deren Verwendung zum Abrufen von Zugriffstoken finden Sie im Übersicht über Brightcove OAuth.

Berechtigungen

Anfragen an die Blacklist API müssen gestellt werden von Kundenanmeldeinformationen mit folgenden Berechtigungen:

video-cloud/playback-auth/blacklist

Token auf der schwarzen Liste verwalten

Es kann bis zu einer Minute dauern, bis Aktualisierungen der Blacklist über das System verbreitet werden. Die Blacklist-API unterstützt die folgenden Anfragen:

Fügen Sie der Blacklist ein Token hinzu:

PUT  (no  req  body)/v1/accounts/{accountID}/blacklist/tokens/{token}

Der gesamte codierte JWT-String ist im Pfad enthalten.

Aktuelle Blacklist anzeigen:

GET  /v1/accounts/{accountId}/blacklist

Prüfen Sie, ob ein Token auf der Blacklist steht:

GET  /v1/accounts/{accountID}/blacklist/tokens/{token}

Der gesamte codierte JWT-String ist im Pfad enthalten.

Antworten:

204 - Der Token ist auf der schwarzen Liste
404 - das Token ist nicht auf der schwarzen Liste

Entfernen eines Tokens aus der Blacklist:

DELETE  /v1/accounts/{accountID}/blacklist/tokens/{token}

Der gesamte codierte JWT-String ist im Pfad enthalten.

Ein Konto prüfen

Mit der Audit-API können Sie einen täglichen Zugriffsbericht für die Nutzung des Playback Authorization Service Ihres Kontos erstellen. Dieser Bericht enthält Details zusammen mit der Autorisierungsantwort für jede Sitzung.

Audit-API

Hier sind die Details für die Audit-API:

Basis-URL

Die Basis-URL für die Audit-API lautet:

https://playback-auth.api.brightcove.com

Account-Pfad

In allen Fällen werden Anfragen für ein bestimmtes Video Cloud-Konto gestellt. Sie fügen also immer den Begriff Konten gefolgt von Ihrer Konto-ID zur Basis-URL hinzu:

https://playback-auth.api.brightcove.com/v1/audit/accounts/{accountID}

Autorisierung

Ein Zugriffstoken für Anfragen ist erforderlich und muss im Autorisierungsheader vorhanden sein።

Authorization:  Bearer  {access_token}

Das Zugriffstoken ist ein temporäres OAuth2-Zugriffstoken, das vom Brightcove OAuth-Dienst abgerufen werden muss. Ausführliche Informationen zum Abrufen von Client-Anmeldeinformationen und deren Verwendung zum Abrufen von Zugriffstoken finden Sie im Übersicht über Brightcove OAuth.

Berechtigungen

Anfragen an die Audit API müssen gestellt werden von Kundenanmeldeinformationen mit folgenden Berechtigungen:

video-cloud/playback-auth/audit

Berichte erstellen

Verwenden Sie die Audit-API, um einen täglichen Zugriffsbericht mit Sitzungsdetails zu erstellen, indem Sie die folgenden Schritte ausführen:

Hinweise:

Alle Autorisierungszugriffsprotokolle für Brightcove befinden sich in der UTC-Zeitzone. Denken Sie daran, Zeitzonen zu berücksichtigen, wenn Anfragen nicht in Ihrem Bericht erscheinen.
Brightcove empfiehlt, Audit-API-Abfrageberichte 6 Stunden nach Mitternacht auszuführen, damit die Verarbeitung aus allen Regionen für alle Autorisierungsdaten vom Vortag abgeschlossen ist. Audit-API-Aufrufe für ein bestimmtes Konto und einen bestimmten Tag werden auf der API-Seite zwischengespeichert. Wenn Sie einen Bericht vor der vorgeschlagenen Mitternacht + 6 Stunden erstellen, stellen Sie möglicherweise fest, dass Ihr Bericht falsch oder unvollständig ist.

Fordern Sie einen täglichen Nutzungsbericht an

Parameter

Feld	Typ	Beschreibung
`accountID`	Zeichenfolge	Ihre Video Cloud-Konto-ID
`date`	Zeichenfolge	Validierungen: Format JJJJ-MM-TT Datum darf nicht heute (UTC-Zeit) sein Datum darf nicht länger als 30 Tage in der Vergangenheit liegen Brightcove behält die Nutzungsberichte des Autorisierungsdienstes nach 30 Tagen nicht bei, um die Einhaltung der DSGVO zu gewährleisten

Anfrage

Methode	BEITRAG
URL	https://playback-auth.api.brightcove.com/v1/audit/accounts/{accountID}/Abfrage/{Datum}
Header	Autorisierung: Träger Ihr Zugangstoken
Header	Inhaltstyp: application/json

Antwort

Beispielantwort (200 OK):

{
	"executionID":  "abcdef-asfdag-dvsbcd"
}

Einzelheiten:

Feld	Typ	Beschreibung
`executionID`	Zeichenfolge	Eine eindeutige ID, die einem Nutzungsbericht für ein bestimmtes `accountID` und zugeordnet ist `date`. Diese ID wird an die anderen Endpunkte unten weitergegeben.

Überprüfen Sie den Status Ihres Berichts

Anfrage

Methode	WERDEN
URL	https://playback-auth.api.brightcove.com/v1/audit/accounts/{accountID}/Ausführung/{executeID}/Status
Header	Autorisierung: Träger Ihr Zugangstoken
Header	Inhaltstyp: application/json

Antwort

Beispielantwort (200 OK):

{
	"status":  "completed"
}

Einzelheiten:

Feld	Typ	Beschreibung
`status`	Zeichenfolge	Werte: "abgeschlossen", "Verarbeitung", "fehlgeschlagen"

Rufen Sie Ihren Bericht ab

Anfrage

Methode	WERDEN
URL	https://playback-auth.api.brightcove.com/v1/audit/accounts/{accountID}/Ausführung/{executeID}/Bericht
Header	Autorisierung: Träger Ihr Zugangstoken
Header	Inhaltstyp: application/json

Antwort

Beispielantwort (200 OK):

{
    "signedURL":  "https://signed-url",
    "expirationTime":  1569219842
}

Einzelheiten:

Feld	Typ	Beschreibung
`SignedURL`	Zeichenfolge	Die Ergebnisse werden als S3-URL zurückgegeben, die Sie herunterladen können.
`expirationTime`	Epochenzeitstempel	Signierte S3-URLs sind 15 Minuten gültig

Einschränkungen

Die folgenden Einschränkungen gelten mit der ersten Version dieser Funktion:

Es gibt ein Limit von 100 Token auf der schwarzen Liste. Danach wird ein Fehler ausgegeben.