Support Kontaktieren Sie Support | Systemstatus Systemstatus
Inhalt der Seite

    Verwenden Sie Postman für API-Anfragen

    In diesem Thema erfahren Sie, wie Sie den beliebten Postman-HTTP-Client so einrichten, dass Anforderungen an die Brightcove RESTful-APIs gestellt werden. Einige finden Curl-Anweisungen und die Befehlszeile, die für die meisten Beispiele in diesem Abschnitt der Dokumentation verwendet werden, schwierig und einschüchternd. Für diese gibt es zahlreiche Tools, um HTTP-Anfragen an REST-basierte Dienste zu senden, zu denen die meisten Brightcove-APIs gehören. Dieses Dokument zeigt Ihnen, wie Sie ein solches Tool verwenden, die Postman-App.

    Installieren Postman

    Bekommen Postman von www.getpostman.com . Postman kann als Chrome- oder Mac-App installiert werden. Wir empfehlen, den Desktop-Client zu erwerben, aber die Chrome-Version kann auf jeder Plattform ausgeführt werden und ist in Funktionalität und Erscheinungsbild identisch.

    Kundendaten abrufen

    Um mit den Brightcove-APIs zu arbeiten, benötigen Sie Client-Anmeldeinformationen für das Konto und die API (s), die Sie verwenden möchten. Beziehen Sie Ihre Client-Anmeldeinformationen in Studio, indem Sie den Anweisungen in folgen Verwalten von API-Authentifizierungsanmeldeinformationen. In den folgenden Schritten werden wir Player Management API-Anforderungen mit verwenden Postman Daher sollten Ihre Anmeldeinformationen mindestens die folgenden Berechtigungen haben:

    • Spieler:: Lesen Schreiben

    Sie können so viele zusätzliche Berechtigungen hinzufügen, wie Sie möchten, um Anmeldeinformationen zu erhalten, die für eine größere Anzahl von API-Anfragen verwendet werden können. Beachten Sie auch, dass Sie Anmeldeinformationen erhalten, die für mehrere Konten funktionieren, wenn Sie möchten.

    Sie können verwenden diese Online-App wenn Sie es vorziehen. Wenn Sie dies tun, müssen Sie mindestens angeben video-cloud/player/all Berechtigungen.

    Verwenden von Postman

    Sobald Sie Ihre Client-Anmeldeinformationen haben, können Sie mit der Verwendung beginnen Postman. Die folgenden Schritte führen Sie durch die Herstellung einiger Player Management API Anfragen mit Postman.

    Einrichten Postman um Zugriffstoken zu erhalten

    1. Starte den Postman App.
    2. Erstellen Sie eine neue Anfrage:
      Neue Anfrage erstellen
      Neue Anfrage erstellen
    3. Geben Sie im neuen Anforderungsdialog "Get Players" als Anforderungsnamen ein:
      Name anfordern
      Name anfordern
    4. Klicken Sie auf "Sammlung erstellen" und geben Sie als Namen der Sammlung "Player Management API" ein:
      Anforderungssammlung erstellen
      Anforderungssammlung erstellen
    5. Speichern Sie die Sammlung.
    6. Suchen Sie die Player Management API-Sammlung in der Liste links und klicken Sie darauf, um Ihre neue Anfrage zu öffnen:
      Spieler-Management-API-Auf
      Spieler-Management-API-Auf
    7. Gehe zum Genehmigung Wählen Sie auf der Registerkarte OAuth 2.0 als Typ aus, und stellen Sie sicher, dass Berechtigungsdaten zu Anforderungsheadern hinzufügen ausgewählt ist:
      Abschnitt „Autorisierung“
      Abschnitt „Autorisierung“
    8. Klicken Holen Sie sich ein neues Zugriffstoken::
      Holen Sie sich neues Zugriffstoken
      Holen Sie sich neues Zugriffstoken
    9. Geben Sie im Dialogfeld folgende Informationen ein:
      • Token-Name:: Player-Verwaltungs-API
      • Grant-Typ:: Client-Anmeld
      • Zugriff auf Token-URL :: https://oauth.brightcove.com/v4/access_token
      • Kunden ID : (Geben Sie Ihre Kunden-ID ein)
      • Kundengeheimnis : (Geben Sie Ihr Kundengeheimnis ein)
      • Umfang : (freilassen)
      • Client-Authentifizierung:: Senden Sie Client-Anmeldeinformationen im Hauptteil
      Dialogfeld „Zugriffstoken holen“
      Dialogfeld „Zugriffstoken holen“
    10. Klicken Token anfordern
    11. Es sollte ein neues Zugriffstoken angezeigt werden:
      Neues Zugriffstoken
      Neues Zugriffstoken

    GET Anfrage senden

    Jetzt können wir API-Anfragen stellen.

    Stellen Sie eine GET Anfrage

    1. Geben Sie nun die folgende URL in das Feld ein Geben Sie die Anforderungs-URL ein Feld, in dem Ihre Konto-ID durch {account_id} ersetzt wird:
      	https://players.api.brightcove.com/v2/accounts/YOUR_ACCOUNT_ID/players
      	
      	
      Anforderungs-URL eingeben
      Anforderungs-URL eingeben
    2. Belassen Sie die Methode als GET und klicken Sie auf Senden::
      Anfrage erhalten
      GET Anfrage
    3. Die Antwort sollte etwa so aussehen:
      GET Antwort
      GET Antwort

    POST Anfrage senden

    Jetzt senden wir eine POST Anfrage mit einigen Daten. In diesem Fall erstellen wir einen neuen Player mithilfe der Player-Verwaltungs-API.

    Stellen Sie eine POST Anfrage

    1. Dupliziere deine Get Players-Anfrage:
      Doppelte Anfrage
      Doppelte Anfrage
    2. Öffnen Sie Ihre neue Anfrage und benennen Sie sie in "Player erstellen" um.
      Anfrage umbenennen
      Anfrage umbenennen
    3. Verwenden Sie dieselbe URL wie für die GET Schritte oben anfordern, aber jetzt wählen POST die ausgewählte HTTP-Methode sein.
      Post Anfrage
      POST Anfrage
    4. Drücke den Körper Registerkarte direkt unter der URL, dann wählen Sie die roh Optionsfeld und JSON (application / json) aus dem Typ-Dropdown-Menü:
      Body anfragen
      Body anfragen
    5. Möglicherweise stellen Sie fest, dass der Anforderung automatisch ein neuer Header hinzugefügt wird. Anforderungen, die Daten senden, benötigen einen Header, der der API mitteilt, welche Art von Daten gesendet werden. Drücke den Überschriften Registerkarte, um die zu sehen Content-Type: application/json Header:
      Header hinzufügen
      Header hinzufügen
    6. Geben Sie für die Rohdaten den folgenden JSON-Code für den Body ein (der Screenshot nach dem JSON zeigt, wie die Anfrage aussehen soll):
      	{
              "name": "Postman Test Player"
              }
      	
    7. Klicken Sie auf Senden.
    8. Ihre Antwort wird wie folgt aussehen (Sie können auf die Schaltfläche „ Pretty “ klicken, um einen besser formatierten JSON zu erhalten):

      POST Antwort
      POST Antwort
    9. Sie können überprüfen, ob Ihr Player erstellt wurde, indem Sie im Abschnitt "Player" von Studio nachsehen.

    Umgebungs-Variablen

    Obwohl Sie Client-Anmeldeinformationen für mehrere Konten und eine beliebige Kombination von API-Vorgängen erstellen können, möchten Sie möglicherweise eine höhere Sicherheit gewährleisten, indem Sie den Umfang Ihrer Anmeldeinformationen auf ein einzelnes Konto und eine API (oder sogar bestimmte API-Vorgänge) beschränken. Wenn ja, können Sie davon profitieren Postman's Umgebungsvariablen Vereinfachung der Testanforderungen für mehrere Konten und APIs. Der Schlüssel besteht darin, Umgebungen einzurichten, die den von Ihnen verwendeten Clientanmeldeinformationen entsprechen.

    Im Folgenden finden Sie die Schritte zum Erstellen und Verwenden von Umgebungsvariablen für das client_id und client_secret .

    1. Klicken Sie oben rechts auf das Zahnradmenü Postman und auswählen Umgebungen verwalten.
      Menü „Umgebungen“
      Menü „Umgebungen“
    2. In dem Umgebungen verwalten Dialog, klicken Sie auf Hinzufügen eine Umgebung hinzufügen.
    3. Geben Sie für die neue Umgebung Folgendes ein:
      • Ein Name (Brightcove APIS oder was auch immer Sie mögen)
      • Eine Umgebungsvariable namens account_id mit einem Wert Ihrer Konto-ID
      • Eine Umgebungsvariable namens client_id mit einem Wert Ihrer Kunden-ID
      • Eine Umgebungsvariable namens client_secret mit einem Wert Ihres Kundengeheimnisses
      Umgebungsvariablen hinzufügen
      Umgebungsvariablen hinzufügen
    4. Klicken Hinzufügen um die Umgebung hinzuzufügen
    5. Schließe Umgebungen verwalten Dialog, zu dem Sie zurückkehren möchten Postman und wählen Sie Ihre Umgebung aus dem Menü.
      Wählen Sie eine Umgebung
      Wählen Sie eine Umgebung aus
    6. Jetzt können Sie fest codierte Werte in Ihren Anforderungen durch Variablen ersetzen. Geben Sie dazu einfach ein {{ Überall wird eine Dropdown-Liste mit Variablen angezeigt:
      Verwenden von Umgebungsvari
      Verwenden von Umgebungsvari

    Erstellen Sie eine Sammlung aus einer API-Referenz

    Ab Version 6.7.4, Postman unterstützt den Import von OpenAPI-Spezifikationen zum Erstellen von Anforderungssammlungen. Da die Plattform-API-Referenzen von Brightcove auf der OpenAPI-Spezifikation basieren, können Sie diese Funktion verwenden, um eine vollständige Sammlung von Anforderungen für eine der Brightcove-APIs zu generieren.

    In den folgenden Schritten verwenden wir die Dynamic Ingest API Als Beispiel, aber das Verfahren funktioniert für alle Brightcove-Plattform-APIs (nicht für die Player-API oder die mobilen SDKs, da Postman nur REST-APIs unterstützt.

    Die Schritte

    1. Gehen Sie in Ihrem Browser zu Dynamic Ingest API-Referenz
    2. Klick auf das Download Schaltfläche unter dem Titel zum Herunterladen der OpenAPI specification für die API:
      OpenAPI Spezifikation herunterladen
      OpenAPI Spezifikation herunterladen
    3. Je nachdem, welchen Browser Sie verwenden, kann die Spezifikation (eine YAML-Datei) heruntergeladen oder in einem neuen Browser-Tab geöffnet werden. Wenn es im Browser geöffnet wird, kopieren Sie den Inhalt und fügen Sie ihn in eine Textdatei ein oder speichern Sie die Seitenquelle auf Ihrem lokalen Laufwerk. Die Datei sollte benannt werden openapi.yaml.
    4. Jetzt geh zu Postman und klicken Sie auf Import Schaltfläche oben im Fenster auf der linken Seite:
      Schaltfläche „Postman Import“
      Schaltfläche „Postman Import“
    5. Ziehen Sie die openapi.yaml Datei von Ihrem Dateimanager in das Importmodal, das geöffnet wird:
      Postman Import Modal
      Postman Import Modal
    6. Nach Postman Wenn Sie die Datei verarbeiten, wird in der Liste mit dem Titel eine neue Sammlung angezeigt Dynamic Ingest API Reference
      Neue Postman-Kollektion
      Neue Postman-Kollektion
    7. Drilldown in die Ordner durch accounts/{account id}/video/{video id} und Sie werden die Anfragen sehen:
      Drilldown zu Anfragen
      Drilldown zu Anfragen
    8. Wähle aus POST Bitte, es zu öffnen. Sie finden beide die Params und die Body aus der API-Referenz vorab ausgefüllt, aber Sie müssen Platzhalter, die den Datentyp anzeigen, durch tatsächliche Daten ersetzen:
      Vorbesiedelte Params
      Vorbesiedelte Params
      Vorbesiedelter Körper
      Vorbesiedelter Körper
    9. Sobald Sie die Platzhalter durch entsprechende Werte ersetzt haben, können Sie die Anforderung genauso verwenden, wie Sie sie selbst erstellt haben.

    Seite zuletzt aktualisiert am 29 Sep. 2020