Verwenden Sie Postman für API-Anfragen

Installieren Postman

Erhalten Postman von postman.com. Es gibt eine Online-Version, die Sie verwenden können, aber wir empfehlen, die Desktop-App zu installieren.

Kundenanmeldeinformationen 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. Rufen Sie Ihre Kundenanmeldeinformationen in Studio ab, indem Sie die Anweisungen in befolgen Anmeldeinformationen für die API-Authentifizierung verwalten. In den folgenden Schritten stellen wir CMS-API-Anforderungen mithilfe von Postman Daher sollten Ihre Anmeldeinformationen mindestens die folgenden Berechtigungen haben:

• Video: Read/Write

Sie können beliebig viele zusätzliche Berechtigungen hinzufügen, um Anmeldeinformationen zu erhalten, die für eine breitere Palette 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/video/all Berechtigungen.

Holen Sie sich die OpenAPI-Spezifikation

Obwohl nicht erforderlich, können Sie die Einrichtung von erheblich vereinfachen Postman besteht darin, die OpenAPI-Spezifikation für die API zu importieren, die Sie verwenden möchten. Sie können dies für jede der Brightcove-Plattform-APIs tun, aber für dieses Tutorial verwenden wir die CMS-API.

Um die OpenAPI-Spezifikation zu erhalten, gehen Sie einfach zum CMS-API-Referenz und klicke auf Herunterladen Taste:

Die heruntergeladene Datei wird aufgerufen openapi.yaml

Importieren Sie die OpenAPI-Spezifikation

Der nächste Schritt besteht darin, die Postman-App zu starten und dann die heruntergeladene OpenAPI-Spezifikation zu importieren:

Öffnen Sie die Sammlung

Wenn die API importiert wird, erzeugt Postman eine Sammlung von Anfragen.

1. Klicken Sie auf Sammlungen.
2. Wählen Sie die neue CMS-API-Sammlung aus:
3. Erweitern Sie die Sammlung und klicken Sie auf das Videos Ordner und wählen Sie die Videos abrufen Anfrage.

   

   

Beachten Sie, dass Postman die meisten Details aus der API-Referenz für Sie eingerichtet hat, einschließlich der Anfrage selbst und der Parameter, die ihr hinzugefügt werden können. Es bietet auch die Dokumentation für die Parameter, lässt Sie die Werte bearbeiten und die Markierung derjenigen entfernen, die Sie nicht mit der Anfrage senden möchten.

Sie müssen jedoch weiterhin einige eigene Informationen angeben, einschließlich der Konto-ID und der Authentifizierungsinformationen. Sie können dies auf Anfrage für Anfrage tun, aber der bessere Weg ist es, eine Umgebung für die Anfrage, wo Sie häufig verwendete Informationen als Variablen speichern können. Das werden wir im nächsten Abschnitt tun.

Schaffen Sie eine Umgebung

Die folgenden Schritte führen Sie durch die Einrichtung einer Umgebung für die CMS-API-Anfragen

1. Klicken Sie auf das Symbol Umgebungsschnellsuche und dann auf Hinzufügen:

   

2. Bearbeiten Sie den Namen der Umgebung und ändern Sie ihn in Brightcove-APIs" (Sie können diese Umgebung auch für andere Brightcove-APIs verwenden und ihr bei Bedarf neue Variablen hinzufügen).

   

3. Klicken Sie auf den Text "Neue Variable hinzufügen", geben Sie ihn ein account_id , und klicken Sie dann in die URSPRÜNGLICHER WERT Feld und geben Sie Ihre Video Cloud-Konto-ID ein (machen Sie dann dasselbe für den AKTUELLEN WERT):

   

4. Wiederholen Sie den vorherigen Schritt, um weitere Variablen hinzuzufügen:

   Umgebungsvariablen

   Variabel	Ursprünglicher Wert
   client_id	(Ihre Kundennummer - siehe Kundenanmeldeinformationen abrufen Oben)
   client_secret	(Ihr Client-Geheimnis - siehe Kundenanmeldeinformationen abrufen Oben)
   access_token_url	https://oauth.brightcove.com/v4/access_token

5. Klicken Speichern um die Umwelt zu schonen:

   

6. Gehen Sie zurück zu Ihrer Brightcove CMS API-Sammlung und wählen Sie die Umgebung aus, die Sie in der Umgebungsauswahl erstellt haben:

   

Umgebungsvariablen können referenziert werden, indem sie in doppelte geschweifte Klammern eingeschlossen werden - Beispiel: {{client_id}}. Postman hilft Ihnen bei der automatischen Vervollständigung, wenn Sie "{{..." eingeben. Sie können dies versuchen, indem Sie zurück zu gehen Holen Sie sich Videos fordern Sie an und geben Sie "{{a" in das Feld ein Wert Feld für die Pfadvariable account_id::

Anfragen aktivieren

Nachdem Sie die Umgebung eingerichtet haben, können Sie die Variablen zum Testen von Anforderungen verwenden. Wir werden uns zuerst die Anfrage zum Abrufen von Videos ansehen.

1. Wenn Sie dies noch nicht getan haben, geben Sie {{account_id}} als Wert für ein account_id Pfadvariable.
2. Drücke den Genehmigung Reiter für die Anfrage:

   

3. Ändern Sie unter Konfigurationsoptionen den Grant-Typ in Client-Credentials:

   

4. Geben Sie die folgenden Variablen aus Ihrer Umgebung in die entsprechenden Felder ein:
   • Zugriffstoken-URL: {{access_token_url}}
   • Kunden ID: {{client_id}}
   • Client-Geheimnis: {{client_secret}}
5. Klicken Holen Sie sich ein neues Zugriffstoken:

   

6. Wenn die Autorisierung abgeschlossen ist, können Sie auf klicken Fortfahren oder warten Sie, bis das Token angezeigt wird. Dann klick Token verwenden:

   

Beachten Sie, dass Brightcove-Zugriffstoken nach fünf Minuten ablaufen. Je nachdem, was Sie tun und wie schnell Sie es tun, können Sie dasselbe Zugriffstoken möglicherweise mehrmals verwenden. Wenn es abläuft, gibt die CMS-API einen nicht autorisierten Fehler zurück:

[
	{
			"error_code": "UNAUTHORIZED",
			"message": "Permission denied."
	}
]

(Die genaue Form der Nachricht kann für andere APIs variieren, ist jedoch ähnlich.)

Kehren Sie in diesem Fall einfach zum Genehmigung tab und fordern Sie ein neues Token an. Sie sollten auch alle abgelaufenen Token löschen, um Verwirrung zu vermeiden, da sie keinen weiteren Wert haben.

Anfragen stellen

Sie können jetzt eine Anfrage zum Abrufen von Videos stellen.

1. Gehen Sie zurück zum Parameter Registerkarte und deaktivieren Sie alle Abfrageparameter (Sie können sie natürlich verwenden und die Werte ändern, aber wir werden nur die Standardwerte für diesen ersten Test verwenden).
2. Klicken Senden.
3. Im Antwortbereich unten sollte JSON-Code angezeigt werden (ein Array von Videometadatenobjekten):

   

4. Jetzt versuchen wir eine Schreibanfrage (Create Video). Wählen Sie diese Anfrage in der Sammlung aus:

   

5. Sie müssen erneut eingeben für die Konto-ID-Pfadvariable. Du wirst NICHT müssen Sie die Schritte im vorherigen Abschnitt wiederholen, um die Autorisierung einzurichten, da Postman diese Einstellungen auf andere Anfragen in der Sammlung überträgt. Jedoch, Sie müssen noch ein neues Zugriffstoken generieren.
6. Als nächstes gehen Sie zum Körper Registerkarte, auf der Sie einen Beispiel-Anfragetext aus der API-Referenz sehen:

   

7. Diese JSON kann bearbeitet werden. Das einzige erforderliche Feld für eine Anforderung zum Erstellen eines Videos ist das name Ändern Sie diesen Wert in "Video testen" und entfernen Sie den Rest des JSON, sodass Ihr Anforderungshauptteil wie folgt lautet:

   {
   	"name": "Test video"
   }

8. Klicken Sie nun auf Senden (erhalten Sie ein neues Zugriffstoken, wenn Sie eines benötigen), und Sie sollten das Metadatenobjekt für das neue Video im Antwortbereich sehen.

Verwandte Themen

• Testtools für Brightcove-APIs
• Authentifizierung für API-Anfragen
• Online-API-Tester
• Schlaflosigkeit für API-Anfragen verwenden