Concepts : Outils de test pour les API Brightcove

Dans cette rubrique, vous découvrirez les outils fournis par Brightcove Learning Services pour vous aider à tester et à apprendre les API RESTful de Brightcove.

Liste des outils

Les outils suivants sont abordés dans ce guide :

Outils de test d'API
Outil de test API
api-testeur.sh Toute API qui utilise Brightcove OAuth pour demandes d'authentification
testeur en ligne Toute API qui utilise Brightcove OAuth pour demandes d'authentification
Insomnie Toute API REST, quelle que soit la méthode d'authentification
Facteur Toute API REST, quelle que soit la méthode d'authentification
  • Un script shell qui peut être exécuté à partir de la ligne de commande si vous travaillez sur MacOS ou un autre système UNIX ou LINUX, ou si vous avez cURL installé sur un système Windows
  • Un outil de test en ligne qui devrait fonctionner dans n'importe quel navigateur
  • Un guide d'utilisation du populaire testeur d'API REST Postman

Le script shell (cURL)

L'outil en ligne de commande est un script shell appelé api-testeur.sh pour obtenir des jetons d'accès et effectuer les appels d'API. Le script api-tester utilise cURL pour effectuer des appels http. cURL est intégré à Mac MacOS et à tous les systèmes Unix/Linux. Pour obtenir cURL sous Windows, consultez Configuration de cURL. Téléchargez ensuite le script api-tester.sh

Vous pouvez voir le code complet du script shell sur Obtenir des jetons d'accès.

Exécuter le script shell

Après avoir téléchargé le script shell, décompressez-le où vous le souhaitez, puis accédez à une ligne de commande dans le même dossier. Pour exécuter le script, tapez :

	bash api-tester.sh

Chaque fois que vous exécutez le script, il vous demandera 5 variables :

  • ID client (voir le rubrique ci-dessous sur l'obtention des identifiants client)
  • Secret client (voir le rubrique ci-dessous sur l'obtention des identifiants client)
  • L'appel d'API complet (exemple : https://cms.api.brightcove.com/v1/accounts/12345678/videos
  • Le verbe de demande est l'un des suivants : OBTENIR | POSTER | PATCH | METTRE | SUPPRIMER (GET est la valeur par défaut)
  • Données de demande : utilisées pour les requêtes POST, PATCH et PUT ; pour les requêtes GET et DELETE, vous laisserez ce champ vide et vous n'aurez qu'à appuyer sur retour

L'outil de ligne de commande renvoie la même réponse que l'outil en ligne, mais il renvoie également la réponse complète, ce qui vous permet de voir les en-têtes et de plus amples informations si la demande échoue pour une raison quelconque. Il fait également écho au JSON brut pour la réponse ainsi qu'à une jolie version imprimée.

L'outil en ligne

L'outil de test en ligne peut être trouvé ici. Comme l'outil en ligne de commande, il vous demande :

  • Un identifiant client
  • Un secret client
  • L'URL complète de la demande d'API
  • Le type de demande
  • Les données JSON à soumettre, le cas échéant

Insomnie

Voir le guide pas à pas pour faire des requêtes API à l'aide d'Insomnia.

Facteur

Voir le guide étape par étape pour faire des demandes d'API à l'aide de Postman.

Obtenir des informations d'identification

Pour utiliser les API Brightcove, vous aurez besoin d'informations d'identification client appropriées, consistant en un client_id et client_secret. Voir le Présentation d'OAuth pour mieux comprendre le flux d'informations d'identification client.

Pour obtenir un client_id et client_secret, vous devez accéder à l'interface utilisateur OAuth et enregistrer une application :

Vous pouvez également obtenir vos informations d'identification via CURL ou Postman, voir :