Verwenden Sie Postman für API-Anfragen
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
- Starte den Postman App.
- Erstellen Sie eine neue Anfrage:
Neue Anfrage erstellen - Geben Sie im neuen Anforderungsdialog "Get Players" als Anforderungsnamen ein:
Name anfordern - Klicken Sie auf "Sammlung erstellen" und geben Sie als Namen der Sammlung "Player Management API" ein:
Anforderungssammlung erstellen - Speichern Sie die Sammlung.
- 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 - 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“ - Klicken Holen Sie sich ein neues Zugriffstoken::
Holen Sie sich neues Zugriffstoken - 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“ - Klicken Token anfordern
- Es sollte ein neues Zugriffstoken angezeigt werden:
Neues Zugriffstoken
GET
Anfrage senden
Jetzt können wir API-Anfragen stellen.
Stellen Sie eine GET
Anfrage
- 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 - Belassen Sie die Methode als
GET
und klicken Sie auf Senden::GET
Anfrage - Die Antwort sollte etwa so aussehen:
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
- Dupliziere deine Get Players-Anfrage:
Doppelte Anfrage - Öffnen Sie Ihre neue Anfrage und benennen Sie sie in "Player erstellen" um.
Anfrage umbenennen - Verwenden Sie dieselbe URL wie für die
GET
Schritte oben anfordern, aber jetzt wählenPOST
die ausgewählte HTTP-Methode sein.POST
Anfrage - 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 - 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 - 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" }
- Klicken Sie auf Senden.
-
Ihre Antwort wird wie folgt aussehen (Sie können auf die Schaltfläche „ Pretty “ klicken, um einen besser formatierten JSON zu erhalten):
POST Antwort - 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
.
- Klicken Sie oben rechts auf das Zahnradmenü Postman und auswählen Umgebungen verwalten.
Menü „Umgebungen“ - In dem Umgebungen verwalten Dialog, klicken Sie auf Hinzufügen eine Umgebung hinzufügen.
- 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 - Klicken Hinzufügen um die Umgebung hinzuzufügen
- 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 aus - 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
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
- Gehen Sie in Ihrem Browser zu Dynamic Ingest API-Referenz
- Klick auf das Download Schaltfläche unter dem Titel zum Herunterladen der OpenAPI specification für die API:
OpenAPI Spezifikation herunterladen - 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
. - Jetzt geh zu Postman und klicken Sie auf Import Schaltfläche oben im Fenster auf der linken Seite:
Schaltfläche „Postman Import“ - Ziehen Sie die
openapi.yaml
Datei von Ihrem Dateimanager in das Importmodal, das geöffnet wird:Postman Import Modal - 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 - Drilldown in die Ordner durch
accounts/{account id}/video/{video id}
und Sie werden die Anfragen sehen:Drilldown zu Anfragen - 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 Vorbesiedelter Körper - Sobald Sie die Platzhalter durch entsprechende Werte ersetzt haben, können Sie die Anforderung genauso verwenden, wie Sie sie selbst erstellt haben.