OAuth-Leitfaden

Brightcove hat ein OAuth 2-System entwickelt, das für alle neuen APIs zur Autorisierung verwendet werden kann. In diesem Thema erfahren Sie, wie Sie OAuth verwenden, um mit der Player Management API zu kommunizieren.

Einleitung

Sie müssen nichts über OAuth wissen, um das System nutzen zu können, und wir erklären Ihnen im Folgenden alles, was Sie für den Einstieg tun müssen. Eine detaillierte Übersicht über OAuth finden Sie im Brightcove OAuth-API Unterlagen.

Gehen Sie folgendermaßen vor, um die OAuth-Authentifizierung zu verwenden:

  1. Holen Sie sich Ihre Kundendaten
  2. Holen Sie sich Ihr Zugriffstoken
  3. Anruf Player Management API
  4. Um die Schritte 2 und 3 zu vereinfachen, verwenden Sie einen serverseitigen Proxy

Bei der Arbeit mit dem Player Management API können Sie auch die Basisauthentifizierung verwenden. Einzelheiten finden Sie im Schritt für Schritt: Spielerverwaltung dokumentieren.

Kundenanmeldeinformationen abrufen

Um OAuth verwenden zu können, müssen Sie zuerst Ihre Client-Anmeldeinformationen ( client_id und client secret) abrufen. Diese Anmeldeinformationen sind für die Konten und API-Operationen gültig, mit denen Sie arbeiten. Dies ist ein einmaliger Vorgang, vorausgesetzt, Sie speichern diese Anmeldeinformationen für die zukünftige Verwendung an einem sicheren Ort.

Es gibt 2 Möglichkeiten, Ihre Anmeldeinformationen zu erhalten:

Für folgende Vorgänge benötigen Sie Berechtigungen:

Als Nächstes benötigen Sie ein OAuth-Zugriffstoken.

Zugriffstoken abrufen

Die Client-Anmeldeinformationen, die Sie im vorherigen Schritt erhalten haben, werden verwendet, um Ihr Zugriffstoken ( access_token) anzufordern, das dann die Autorisierung für einen API-Aufruf bereitstellt. Da dieses Token nur 5 Minuten gültig ist, müssen Sie in den meisten Fällen für jeden API-Aufruf einen erhalten.

Führen Sie diese Schritte aus, um Ihr Zugriffstoken mithilfe von cURL abzurufen:

  1. Verwenden Sie in Ihrer Befehlszeile die export Befehl, um die Werte für Ihre Client-ID und Ihr Client-Geheimnis festzulegen.

        export CLIENT_ID=your client id value
                  export CLIENT_SECRET=your client secret value
  2. Kopieren Sie die folgende cURL-Anweisung, fügen Sie sie in Ihre Befehlszeile ein und drücken Sie die Eingabetaste.

        curl
                  -s
                  --user $CLIENT_ID:$CLIENT_SECRET
                  --header "Content-Type: application/x-www-form-urlencoded"
                  --data "grant_type=client_credentials"
                  https://oauth.brightcove.com/v4/access_token
  3. Ihre Antwort sollte ungefähr so aussehen:

        {"access_token":"AGUq5IQzLzrRvs8CNbhYlBFeB1_B6jTJrcE8grFHEJaPRsPeEg3-S_Apgv8VKiZ-nzxjDGtKwAco9q3z8tdzrxq76k6B9tUXk9HYQOIYgqziWbuvA50VaW8AK2MQFc0G3-woH_kgQxNQUaVNEpE1sePE9GUb2u9FfeQyLw8XQE_QfriYwkkcQoaGOusoIpujx8H6dLFovPuH5F5N3OSxNYhNZrdOhJwkdN7oe076j3xwNRarHn5IRPYKzjOMbqDk552aAhJxo2pYWoDh3q63pBrzre4Bj1rCHKJPifPEMrgPWzG1Uz1BPhQb5_ubr4P8mtnhCjJn4zzT_1-C8ActMUof45kVFhG4VTWRA8rh05THqEBj_TzPIR7L1t5oHhLo5ziILNSp7mZRM3folvYJC6YIhY7M4qLNGR5iq3nerlv5Ufr_bI-1AnP7a68JasawDpZxjfoGf3h6cwIZJr2uG_iU4FO9Ig-Gotaqv5mLWmUgR-DJ3sfRADc",
                  "token_type":"Bearer",
                  "expires_in":300}

Mit Ihrem Zugriffstoken sind Sie bereit, mit dem zu kommunizieren Player Management API.

Anruf Player Management API

So verwenden Sie OAuth für die Kommunikation mit dem Player Management API benötigen Sie das Zugriffstoken, das Sie im vorherigen Abschnitt generiert haben. Denken Sie daran, dass dieses Token nach 5 Minuten abläuft. Wenn Ihr Zugriffstoken abgelaufen ist, müssen Sie möglicherweise die vorherigen Abschnittsschritte wiederholen.

Führen Sie diese Schritte aus, um Informationen zur Player-Konfiguration mithilfe von cURL abzurufen:

  1. Verwenden Sie in Ihrer Befehlszeile die export Befehl, um die Werte für Ihr Zugriffstoken, Konto-ID und Spieler-ID festzulegen.

        export ACCESS_TOKEN=your access token value
                  export ACCOUNT_ID=your account id
                  export PLAYER_ID=your player id
  2. Kopieren Sie die folgende cURL-Anweisung, fügen Sie sie in Ihre Befehlszeile ein und drücken Sie die Eingabetaste.

        curl
                  --header "Content-Type: application/json"
                  --header "Authorization: Bearer $ACCESS_TOKEN"
                  --request GET
                  https://players.api.brightcove.com/v2/accounts/{account_id}/players/{player_id}/configuration
  3. Ihre Antwort sollte ungefähr so aussehen:

        {"video_cloud":{"video":null,"policy_key":"BCpkADawqM3VpA66ktTO5bdLTmz6kLGMvGZrSyp-YTvbc4MHllmDmuwzEseO1uTeYYRqygGHhB_MgMaM6ndh5ch-cKYtMFx3LerHyziID8M19b162eeIXKYaxDf8uh4OsLTxVijM-qT1N5QR"},
                  "stylesheets":["https://solutions.brightcove.com/bcls/brightcove-player/disabled-scrubber/disabled-scrubber.css"],
                  "scripts":[],"plugins":[],
                  "player":{"template":{"version":"1.14.22","name":"single-video-template"}},
                  "autoadvance":0}

Um mehr über alle Anfragen zu erfahren, die Sie an die stellen können Player Management API siehe die Helle Bucht Player Management API Referenzdokument.