Concepts : Outils de test pour les API Brightcove

Liste des outils

Les outils suivants sont abordés dans ce guide :

• 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 installé cURL sur un système Windows
• Un outil de test en ligne qui devrait fonctionner dans n'importe quel navigateur
• Un guide pour l'utilisation du populaire Testeur d'API REST Postman

Le script shell (cURL)

L'outil en 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-testeur utilise cURL pour effectuer des appels http. cURL est intégré sur Mac macOS et tous les systèmes Unix/Linux. Pour obtenir cURL sous Windows, consultez Configuration de cURL. Ensuite, téléchargez le script api-tester.sh

Vous pouvez voir le code complet du script shell à l'adresse Getting Access Tokens.

Exécution du 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 la section ci-dessous sur l'obtention des informations d'identification du client)
• Client Secret (voir la section ci-dessous sur l'obtention des informations d'identification client)
• L'appel d'API complet (exemple : https://cms.api.brightcove.com/v1/accounts/12345678/videos
• Le verbe de requête - l'un des éléments suivants : GET | POST | PATCH | PUT | DELETE (GET est la valeur par défaut)
• Données de demande - utilisées pour POST, PATCH et PUT ; pour les requêtes GET et DELETE, vous laisserez ce vide et appuyez simplement sur la touche Retour

L'outil en ligne de commande retournera la même réponse que l' 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 échos également le JSON brut pour la réponse ainsi qu'une version joolement imprimée.

L'outil en ligne

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

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

Insomnie

Consultez le guide étape par étape pour faire des demandes d'API à l'aide d'Insomnia.

Facteur

Consultez le guide étape par étape pour effectuer des requêtes API à l'aide de Postman.

Obtenir des informations

Pour utiliser les API Brightcove, vous aurez besoin d'informations d'identification client appropriées, consistant en un client_id et client_secret. Consultez la 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 :

• Gestion des informations d'identification d'authentification API

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

• Obtenir les informations d'identification client en utilisant CURL
• Obtenir les informations d'identification du client à l'aide