Support Kontakt Support | Systemstatus Systemstatus

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 zum Senden von HTTP-Anforderungen an REST-basierte Dienste, einschließlich der meisten Brightcove-APIs. Dieses Dokument zeigt Ihnen, wie Sie ein solches Tool verwenden, die Postman-App.

installieren Postman

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

Client-Anmeldeinformationen abrufen

Um mit den Brightcove-APIs arbeiten zu können, benötigen Sie Client-Anmeldeinformationen für das Konto und die APIs, die Sie verwenden möchten. Beziehen Sie Ihre Client-Anmeldeinformationen in Studio, indem Sie den Anweisungen in folgen API-Authentifizierungsdaten verwalten. In den folgenden Schritten werden wir machen Player Management API Anfragen mit PostmanDaher sollten Ihre Anmeldeinformationen mindestens die folgenden Berechtigungen aufweisen:

  • Players: Read/Write

Sie können so viele zusätzliche Berechtigungen hinzufügen, wie Sie möchten, um Anmeldeinformationen zu erhalten, die für einen größeren Bereich von API-Anforderungen 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 bevorzugen. Wenn Sie dies tun, müssen Sie mindestens angeben video-cloud/player/all Berechtigungen.

Es ist recht schwierig viele Produkte gleichzeitig zu verwenden und auch hintereinander aufzutragen. Die Wirkstoffe können nicht alle gleichzeitig aufgenommen werden und die Haut ist schließlich überfordert. Die Folge könnten Hautrötungen und Unverträglichkeiten sein. Postman

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

Einrichten Postman um Zugriffsmarken zu erhalten

  1. Starten Sie die Postman App.
  2. Erstellen Sie eine neue Anfrage:
    Erstellen Sie eine neue Anfrage
    Erstellen Sie eine neue Anfrage
  3. Geben Sie im neuen Anforderungsdialog "Get" ein Players "für den Anforderungsnamen:
    Anforderungsname
    Anforderungsname
  4. Klicken Sie auf Sammlung erstellen und geben Sie dann "Player Management API"für den Sammlungsnamen:
    Erstellen Sie eine Antragssammlung
    Erstellen Sie eine Antragssammlung
  5. Speichern Sie die Sammlung.
  6. Finden Sie die Player Management API Sammlung in der Liste auf der linken Seite und klicken Sie darauf, um Ihre neue Anfrage zu öffnen:
    Player Management API Kollektion
    Player Management API Kollektion
  7. Gehen Sie zum Genehmigung Wählen Sie auf der Registerkarte OAuth 2.0 als Typ aus, und stellen Sie sicher, dass Autorisierungsdaten zu Anforderungsheadern hinzufügen ausgewählt ist:
    Autorisierungsabschnitt
    Autorisierungsabschnitt
  8. Eine detaillierte Holen Sie sich ein neues Zugangstoken:
    Holen Sie sich ein neues Zugangstoken
    Holen Sie sich ein neues Zugangstoken
  9. Geben Sie im Dialog die folgenden Informationen ein:
    • Tokenname: Player Management API
    • Erteilungsart: Kundenanmeldeinformationen
    • Zugriffstoken-URL: https://oauth.brightcove.com/v4/access_token
    • Kunden-ID: (Geben Sie Ihre Kunden ID ein)
    • Kundengeheimnis: (Geben Sie Ihr Kundengeheimnis ein)
    • Geltungsbereich: (freilassen)
    • Client-Authentifizierung: Senden Sie die Client-Anmeldeinformationen im Hauptteil
    Erhalten Sie Zugriffstoken-Dialog
    Erhalten Sie Zugriffstoken-Dialog
  10. Eine detaillierte Anfrage Token
  11. Sie sollten ein neues Zugriffstoken angezeigt bekommen:
    Neues Zugangstoken
    Neues Zugangstoken

Senden GET Anforderung

Jetzt sind wir bereit, API-Anfragen zu stellen.

Mach ein GET Anforderung

  1. Geben Sie nun die folgende URL in die URL ein Geben Sie die Anfrage-URL ein Feld, ersetzen Sie Ihre Konto-ID für {account_id}:
    	https://players.api.brightcove.com/v2/accounts/YOUR_ACCOUNT_ID/players
    	
    	
    Geben Sie die Anfrage-URL ein
    Geben Sie die Anfrage-URL ein
  2. Belassen Sie die Methode als GETUnd klicken Sie auf Senden:
    Anfrage erhalten
    GET Ihre Anfrage
  3. Die Antwort sollte etwa so aussehen:
    Erhalten Antwort
    Erhalten Antwort

Senden POST Anforderung

Jetzt werden wir eine senden POST Anfrage mit einigen Daten. In diesem Fall erstellen wir eine neue player Verwendung der Player Management API.

Mach ein POST Anforderung

  1. Dupliziere dein Get Players Anfrage:
    Doppelte Anfrage
    Doppelte Anfrage
  2. Öffnen Sie Ihre neue Anfrage und benennen Sie sie in "Erstellen" um Player"
    Anfrage umbenennen
    Anfrage umbenennen
  3. Verwenden Sie die gleiche URL wie für die GET Anfrage Schritte oben, aber jetzt wählen POST um die ausgewählte HTTP-Methode zu sein.
    Anfrage senden
    POST Ihre Anfrage
  4. Klicken Sie auf die Körper Klicken Sie unter der URL auf die Registerkarte und wählen Sie dann die Option roh Optionsfeld und JSON (Anwendung / JSON) aus dem Dropdown-Menü:
    Anfragetext
    Anfragetext
  5. Sie werden feststellen, dass ein neuer Header automatisch zur Anfrage hinzugefügt wird. Anfragen, die Daten senden, benötigen einen Header, der der API mitteilt, welche Art von Daten gesendet werden. Drücke den Headers Tab um das zu sehen Content-Type: application/json Header:
    Kopfzeile hinzufügen
    Kopfzeile hinzufügen
  6. Geben Sie für die Rohdaten den folgenden JSON-Code für den Body ein (der Screenshot, der auf JSON folgt, zeigt, wie die Anfrage aussehen soll):
    	{
            "name": "Postman Test Player"
            }
    	
  7. Eine detaillierte Senden.
  8. Ihre Antwort sieht etwa wie folgt aus (Sie können auf die Schaltfläche klicken Ziemlich Taste für schön formatiertes JSON):

    POST-Antwort
    POST-Antwort
  9. Sie können überprüfen, ob Ihre player wurde durch Einchecken in erstellt Players Abschnitt von Studio.

Umgebungsvariablen

Obwohl Sie Clientanmeldeinformationen für mehrere Konten und eine beliebige Kombination von API-Vorgängen erstellen können, möchten Sie möglicherweise mehr Sicherheit erhalten, indem Sie den Umfang Ihrer Anmeldeinformationen auf ein einziges Konto und eine einzige API oder sogar bestimmte API-Vorgänge beschränken. Wenn ja, können Sie davon profitieren Postman's Umgebungsvariablen um Testanforderungen für mehrere Konten und APIs zu vereinfachen. Der Schlüssel besteht darin, Umgebungen einzurichten, die den einzelnen von Ihnen verwendeten Clientanmeldeinformationen entsprechen.

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

  1. Klicken Sie oben rechts auf das Zahnradmenü Postman und wählen Sie Umgebungen verwalten
    Menü "Umgebungen"
    Menü "Umgebungen"
  2. In dem Umgebungen verwalten Dialog, klicken Sie auf Add um eine Umgebung hinzuzufü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 Client-ID
    • Eine Umgebungsvariable namens client_secret mit einem Wert Ihres Kundengeheimnisses
    Fügen Sie Umgebungsvariablen hinzu
    Fügen Sie Umgebungsvariablen hinzu
  4. Eine detaillierte Add um die Umgebung hinzuzufügen
  5. Schließe Umgebungen verwalten Dialog, um zu zurückzukehren 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 beginnen, fest codierte Werte in Ihren Anfragen durch Variablen zu ersetzen. Um dies zu tun, geben Sie einfach ein {{ Überall wird eine Dropdown-Liste mit Variablen angezeigt:
    Umgebungsvariablen verwenden
    Umgebungsvariablen verwenden

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 die Player API oder die mobilen SDKs, da Postman nur REST-APIs unterstützt).

Shritte

  1. Gehen Sie in Ihrem Browser zu Dynamic Ingest API Referenz
  2. Klicken Sie auf Download Klicken Sie unter dem Titel auf, um die herunterzuladen OpenAPI specification für die API:
    Laden Sie die OpenAPI-Spezifikation herunter
    Laden Sie die OpenAPI-Spezifikation herunter
  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. Gehe jetzt zu Postman Und klicken Sie auf die 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 sich öffnende Import-Modal:
    Briefträger Import Modal
    Briefträger Import Modal
  6. Nachher Postman verarbeitet die Datei, sehen Sie eine neue Sammlung in der Liste mit dem Titel Dynamic Ingest API Reference
    Neue Briefträgersammlung
    Neue Briefträgersammlung
  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 Params und das Body Aus der API-Referenz bereits ausgefüllt, aber Sie müssen Platzhalter, die den Datentyp anzeigen, durch tatsächliche Daten ersetzen:
    Vorbestückte Params
    Vorbestückte Params
    Vorbestückter Körper
    Vorbestückter 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 20. März 2020