Konzepte: Testen von Tools für Brightcove-APIs

Liste der Werkzeuge

Die folgenden Tools werden in diesem Handbuch behandelt:

• Ein Shell-Skript, das über die Befehlszeile ausgeführt werden kann, wenn Sie unter MacOS oder einem anderen UNIX- oder LINUX-System arbeiten oder wenn Sie dies getan haben cURL installiert auf einem Windows-System
• Ein Online-Test-Tool, das in jedem Browser funktionieren sollte
• Eine Anleitung zur Verwendung des beliebten Postman REST API Testers

Das Shell-Skript (cURL)

Das Befehlszeilentool ist ein Shell-Skript namens api-tester.de um Zugangstoken zu erhalten und die API-Aufrufe zu machen. Das API-Tester-Skript verwendet cURL, um HTTP-Aufrufe auszuführen. cURL ist auf Mac MacOS und allen Unix / Linux-Systemen integriert. Um cURL unter Windows zu erhalten, siehe CURL einrichten. Dann lade die api-test.sh-Skript

Sie können den vollständigen Code für das Shell-Skript unter sehen Zugriffstoken erhalten.

Das Shell-Skript ausführen

Nachdem Sie das Shell-Skript heruntergeladen haben, entpacken Sie es, wo immer Sie möchten, und gehen Sie dann zu einer Befehlszeile im selben Ordner. Geben Sie Folgendes ein, um das Skript auszuführen:

	bash api-tester.sh

Jedes Mal, wenn Sie das Skript ausführen, werden Sie nach 5-Variablen gefragt:

• Kunden-ID (siehe Abschnitt unten beim Abrufen von Client-Anmeldeinformationen)
• Kundengeheimnis (siehe Abschnitt unten beim Abrufen von Client-Anmeldeinformationen)
• Der vollständige API-Aufruf (Beispiel: https://cms.api.brightcove.com/v1/accounts/12345678/videos
• Das Anforderungsverb - eines der folgenden: GET | POST | PATCH | PUT | LÖSCHEN (GET ist der Standard)
• Daten anfordern - für POST, PATCH und PUT verwendet; Für GET- und DELETE-Anfragen lassen Sie dieses Feld leer und drücken Sie einfach Rückkehr

Das Befehlszeilentool gibt dieselbe Antwort zurück wie das Online-Tool - Es wird jedoch auch die vollständige Antwort angezeigt, mit der Sie die Header und weitere Informationen anzeigen können, wenn die Anforderung aus irgendeinem Grund fehlschlägt. Es gibt auch das rohe JSON für die Antwort sowie eine hübsch gedruckte Version.

Das Online-Tool

Das Online-Test-Tool finden Sie hier hier. Wie das Befehlszeilentool fordert es Sie auf:

• Eine Kunden-ID
• Ein Client-Geheimnis
• Die vollständige API-Anforderungs-URL
• Der Anfragetyp
• Die JSON-Daten, die ggf. übermittelt werden sollen

Insomnia

Siehe die Schritt-für-Schritt-Anleitung zum Erstellen von API-Anfragen mit Insomnia.

Postman

Siehe die Schritt-für-Schritt-Anleitung zum Erstellen von API-Anfragen mit Postman.

Anmeldedaten erhalten

Um die Brightcove-APIs verwenden zu können, benötigen Sie die richtigen Client-Anmeldeinformationen, bestehend aus a client_id und client_secret. Siehe OAuth-Übersicht um den Client-Credential-Flow besser zu verstehen.

Um eine zu bekommen client_id und client_secret, müssen Sie zur OAuth-Benutzeroberfläche gehen und eine App registrieren:

• API-Authentifizierungsdaten verwalten

Sie können Ihre Anmeldeinformationen auch über CURL oder Postman erhalten - siehe:

• Abrufen von Clientanmeldeinformationen mithilfe von CURL
• Abrufen von Clientanmeldeinformationen mit Postman