Paper Contacter le support | état du système L'état du système

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 Brightcove RESTful.

Liste des outils

Les outils suivants sont discutés dans ce guide:

Outils de test d'API
Outil de test Apis
api-tester.sh Toute API qui utilise Brightcove OAuth pour authentifier les demandes
testeur en ligne Toute API qui utilise Brightcove OAuth pour authentifier les demandes
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 sur 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 pour utiliser le populaire testeur d'API REST de Postman

Le script shell (cURL)

L'outil de ligne de commande est un script shell appelé api-tester.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é sur Mac MacOS et tous les systèmes Unix / Linux. Pour obtenir cURL sur Windows, voir Configuration de cURL. Puis téléchargez le script api-tester.sh

Vous pouvez voir le code complet du script shell à 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 des variables 5:

  • ID client (voir le section ci-dessous sur l'obtention des informations d'identification du client)
  • Client Secret (voir le section ci-dessous sur l'obtention des informations d'identification du client)
  • L'appel API complet (exemple: https://cms.api.brightcove.com/v1/accounts/12345678/videos
  • Le verbe de requête - un des suivants: GET | POST | PATCH | PUT | DELETE (GET est la valeur par défaut)
  • Demande de données - utilisé pour POST, PATCH et PUT; pour les requêtes GET et DELETE, vous laissez ce champ vide et appuyez simplement sur retourner

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

L'outil en ligne

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

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

Insomnie

Voir le guide étape par étape pour faire des demandes d'API en utilisant l'insomnie.

Facteur

Voir le guide étape par étape pour faire des demandes d'API en utilisant Postman.

Obtenir des informations d'identification

Pour utiliser les API Brightcove, vous aurez besoin des informations d'identification client appropriées, consistant en un client_id et client_secret. Voir l' Présentation de OAuth pour avoir une meilleure compréhension du flux des informations d'identification du client.

Pour obtenir une client_id et client_secret, vous devrez aller à l'interface utilisateur OAuth et enregistrer une application:

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


Dernière mise à jour de la page le 16 mars 2020