Konzepte: Tools für Brightcove-APIs testen

Liste der Werkzeuge

Die folgenden Tools werden in diesem Handbuch erläutert:

• 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-Testtool, 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.sh um Zugriffstoken zu erhalten und die API-Aufrufe durchzuführen. Das API-Tester-Skript verwendet cURL, um http-Aufrufe durchzuführen. cURL ist in Mac MacOS und allen Unix / Linux-Systemen integriert. Informationen zum Abrufen von cURL unter Windows finden Sie unter CURL einrichten. Dann laden Sie die api-tester.sh-Skript

Den vollständigen Code für das Shell-Skript finden Sie unter Zugriffstoken erhalten.

Ausführen des Shell-Skripts

Nachdem Sie das Shell-Skript heruntergeladen haben, entpacken Sie es, wo immer Sie möchten, und wechseln 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 zur Eingabe von 5 Variablen aufgefordert:

• Client ID (siehe die Abschnitt unten beim Abrufen von Client-Anmeldeinformationen)
• Kundengeheimnis (siehe die 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 die Standardeinstellung)
• Anforderungsdaten - werden 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 wiedergegeben, sodass Sie die Header und weitere Informationen anzeigen können, wenn die Anforderung aus irgendeinem Grund fehlschlägt. Es gibt auch den rohen JSON für die Antwort sowie eine hübsch gedruckte Version wieder.

Das Online-Tool

Das Online-Testtool finden Sie hier Hier. Wie das Befehlszeilentool werden Sie gefragt:

• Eine Client-ID
• Ein Kundengeheimnis
• Die vollständige API-Anforderungs-URL
• Der Anforderungstyp
• Gegebenenfalls die zu übermittelnden JSON-Daten

Schlaflosigkeit

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

Briefträger

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

Anmeldeinformationen

Um die Brightcove-APIs verwenden zu können, benötigen Sie die richtigen Client-Anmeldeinformationen, bestehend aus a client_id und client_secret. Siehe die OAuth-Übersicht um ein besseres Verständnis des Ablaufs der Client-Anmeldeinformationen zu erhalten.

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

• Verwalten von Anmeldedaten für API-

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

• Holen Sie sich Client-Anmeldeinformationen mit
• Holen Sie sich Client-Anmeldeinformationen mit