Schnellstart: OAuth-API

Dieses Tutorial führt Sie durch die Schritte zum Abrufen von Client-Zugangsdaten und eines Zugriffstokens mithilfe der OAuth-API.

Voraussetzungen

  • API-Aufrufe in diesem Tutorial verwenden cURL, das auf MacOS und allen Linux-/Unix-Systemen integriert ist. Wenn Sie Windows ausführen, lesen Sie cURL einrichten
  • Sie benötigen Terminal oder eine andere Befehlszeilenkonsole für Ihr System

Überblick

Die Verwendung der Brightcove OAuth-API für den Zugriff auf andere Brightcove-APIs besteht aus zwei Teilen.

  • Holen Sie sich die Client-Anmeldeinformationen (a client_id und client_secret) , die für die Konten und API-Operationen gültig sind, die Sie benötigen. Dies ist ein einmaliger Vorgang, vorausgesetzt, Sie speichern Ihre client_id und client_secret für die zukünftige Verwendung an einem sicheren Ort
  • Holen Sie sich ein access_token das die Autorisierung zum Ausführen eines API-Aufrufs bereitstellt - das access_token ist 5 Minuten lang gültig. In den meisten Fällen erhalten Sie also eines für jeden API-Aufruf, den Sie tätigen

Es gibt auch eine Benutzeroberfläche in Studio, mit der Sie Kunden-Zugangsdaten abrufen und verwalten. Es wird empfohlen, nach Möglichkeit die Benutzeroberfläche zu verwenden. Bei neuen APIs sind die Anmeldeinformationen möglicherweise für einige Zeit nicht über die Benutzeroberfläche verfügbar. In diesem Fall können Sie die Anmeldeinformationen direkt von der OAuth-API abrufen, wie Sie in den folgenden Schritten erfahren.

Kundenanmeldeinformationen abrufen

In diesen Schritten verwenden wir einen cURL-Befehl, um Client-Anmeldeinformationen für die Player Management API abzurufen.

Schritte

  1. Stellen Sie sicher, dass cURL verfügbar ist, wie in den Anforderungen beschrieben. Sie können testen, indem Sie in eine Befehlszeile gehen und die Eingabetaste eingeben curl und drücken. Wenn cURL installiert ist, sollte eine Meldung wie diese angezeigt werden: 
            curl: try 'curl --help' or 'curl --manual' for more information
  2. Jetzt benötigen Sie zwei Informationen, die Sie von Studio erhalten können. Melden Sie sich bei Studio an, indem Sie zu Studio gehen.
    • Konto-ID
    • BC_TOKEN

    Hinweis: Die BC_TOKEN value ist ein Cookie, das beim Öffnen von Studio gesetzt wird. Es hat keinen Bezug zu den API Management-Token, mit denen Sie in Studio arbeiten.

Rufen Sie Ihre Konto-ID und BC_TOKEN ab

  1. Zuerst benötigen Sie Ihre Konto-ID aus den Kontoinformationen.
  2. Klicken Sie auf das Einstellungssymbol Account-Einstellungen im Studio-Header.
  3. Wählen Sie Kontoinformationen aus der Dropdown-Liste aus.
  4. Kopiere deine Konto-ID von der Seite mit den Kontoinformationen und speichere sie — du wirst sie in einem späteren Schritt benötigen.
  5. Öffnen Sie nun die Browser-Entwicklerkonsole - in den meisten Browsern können Sie dies tun, indem Sie OPTION-CMD-i (Mac) oder ALT-CTRL-i (Windows) drücken, oder Sie sollten auch einen Menüpunkt finden können.
  6. Fügen Sie in der Konsole das folgende JavaScript ein und drücken Sie die Eingabetaste, um Ihr BC_TOKEN in einem modalen Dialogfeld anzuzeigen:
  7. Kopieren Sie das BC_TOKEN in die Zwischenablage.
  8. Geben Sie hier Ihre Konto-ID und BC_TOKEN ein:

    Konto-ID:

    BC_TOKEN:

Stellen Sie die Anmeldeinformationen anfordern

  1. Um Ihre Client-Anmeldeinformationen abzurufen, kopieren Sie den folgenden cURL-Befehl, fügen Sie ihn in Ihre Befehlszeile ein und drücken Sie die Eingabetaste:
  2. Die Antwort sollte wie folgt aussehen (Formatierung hinzugefügt): 
            {"redirect_url":null,"maximum_scope":[{"identity":
        {"type":"video-cloud-account","account-id":57838016001},
        "operations":["video-cloud/player/all"]}],"name_html":"Sample-Client",
        "issued_to":"rcrooks@brightcove.com","trusted":null,"expires_at":null,
        "issued_at":"2015-06-18T20:17:12Z","name":"Sample-Client",
        "description_html":null,"revoked":null,"type":"credential",
        "client_secret":"PiQ5s3-tk46DvNBPauknctP3aTIS07zNIa7Kxz3b7hnRMA5JvQdkwa7JpyuX7dnD4RXziA4KEK0n1pEO94Q7,
        "description":null,"client_id":"b63e5ac2-5264-4a5a-971a-a133bc7bd605",
        "issued_user":53255203001}

    Das ist nicht ein gültiges Client-Geheimnis - das solltest du noch nie ein Client-Geheimnis öffentlich preisgeben.

  3. Geben Sie die Werte für die ein client_id und client_secret unten, da Sie diese jedes Mal benötigen, wenn Sie eine access_token.
    Kundenanmeldeinformationen

    Kunden-ID:

    client_secret:

Zugriffstoken erhalten

Das client_id und client_secret Sie erhalten in den vorherigen Schritten erhalten werden als Benutzername Passwort Kombination zur Authentifizierung, wenn Sie eine anfordern access_token. In cURL, die wir hier verwenden, können Sie diese als --user Parameter. In anderen Sprachen übergeben Sie diese in einem Basic Authorization-Header mit Ihrer HTTP-Anfrage:

        Authorization: Basic {client_id:client_secret}

Hinweis: Die gesamte client_id:client_secret muss Base64-codiert sein, um von der OAuth-API akzeptiert zu werden. cURL kodiert die --user-Anmeldeinformationen automatisch mit Base64, in anderen Sprachen müssen Sie sie jedoch selbst mit Base64 codieren.

Schritte

  1. Um Ihr access_token zu erhalten, kopieren Sie den folgenden cURL-Befehl, fügen Sie ihn in Ihre Befehlszeile ein und drücken Sie die Eingabetaste:
  2. Die Ausgabe sollte so aussehen: 
            {"access_token":"ACkkpftcuhyzqdf4ftxm304za3anhziG0Ni5-S_dplxMNYNrSrBZRgJL3sf_U38ZZVDdgkmWtrb0_GRZj-VzWOAFWgpEYwgwIWLjcGsTI-9QMUMNv2eFj33clsWFHnGLzgtdcILXpR-wPM0LzKKzRahodwofPfuExYCej18Wpt1x7DxOJDySEjCGOWiTuZVKp1QjG0_nqD9T3TpK3Cchv0suVRTGkYrs15qYSKdxh2-e5XbUiKKptNl8ryvMriavPN66fOh17c09Q0525OPqejkU6uERPTw-sTLU_QjJbRV6psxoSVYKRAetsBikH9XRJbZCSt2JP88O","token_type":"Bearer","expires_in":300}
  3. Dieses Token kann verwendet werden, um Aufrufe an die Player Management API 5 Minuten lang zu authentifizieren (dann benötigen Sie ein neues Token). Das Token wird im Authorization-Header mit der HTTP-Anfrage übergeben: 
            Authorization: Bearer access_token value