Konzepte: Testtools für Brightcove-APIs

In diesem Thema lernen Sie die Tools kennen, die Brightcove Learning Services zum Testen und Erlernen der Brightcove-RESTful-APIs bereitstellt.

Liste der Werkzeuge

Die folgenden Tools werden in diesem Handbuch behandelt:

API-Testtools
Testtool APIs
api-tester.sh Jede API, die Brightcove OAuth für die Authentifizierung von Anfragen verwendet
Online-Tester Jede API, die Brightcove OAuth für die Authentifizierung von Anfragen verwendet
Schlaflosigkeit Beliebige REST-API, unabhängig von der Authentifizierungsmethode
Postbote Beliebige REST-API, unabhängig von der Authentifizierungsmethode
  • Ein Shell-Skript, das über die Befehlszeile ausgeführt werden kann, wenn Sie mit MacOS oder einem anderen UNIX- oder LINUX-System arbeiten oder wenn Sie 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 zu tätigen. cURL ist auf Mac MacOS und allen Unix/Linux-Systemen integriert. Informationen zum Abrufen von cURL unter Windows finden Sie unter cURL einrichten. Laden Sie dann das Skript api-tester.sh herunter

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 an einer beliebigen Stelle 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 zur Eingabe von 5 Variablen aufgefordert:

  • Kunden-ID (siehe die Abschnitt unten beim Abrufen von Kundendaten)
  • Client-Geheimnis (siehe die Abschnitt unten beim Abrufen von Kundendaten)
  • Der vollständige API-Aufruf (Beispiel: https://cms.api.brightcove.com/v1/accounts/12345678/videos
  • Das Anfrageverb - eines der folgenden: ERHALTEN | POST | PATCH | PUT | DELETE (GET ist die Standardeinstellung)
  • Anforderungsdaten - verwendet für POST, PATCH und PUT; für GET- und DELETE-Anfragen lassen Sie dieses Feld leer und drücken einfach Rückkehr

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

Das Online-Tool

Das Online-Testtool finden Sie Hier. Wie das Befehlszeilentool fragt es Sie nach:

  • Eine Client-ID
  • Ein Kundengeheimnis
  • Die vollständige API-Anfrage-URL
  • Der Anfragetyp
  • Die ggf. zu übermittelnden JSON-Daten

Schlaflosigkeit

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

Postbote

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

Zugangsdaten abrufen

Um die Brightcove-APIs zu verwenden, benötigen Sie die richtigen Client-Anmeldeinformationen, bestehend aus: client_id und client_secret. Siehe die OAuth-Übersicht um ein besseres Verständnis für den Fluss der Kundenanmeldeinformationen zu erhalten.

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

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