Facteur

Nos API peuvent être utilisées avec n'importe quel client HTTP ; toutefois, nous recommandons d'utiliser les API suivantes FacteurUne interface graphique conviviale pour un puissant client HTTP multiplateforme.

Vonage a créé une collection Postman, conçue pour vous permettre de démarrer rapidement avec nos API les plus utilisées. L'espace de travail est structuré par capacité, ce qui vous permet de trouver facilement l'API que vous recherchez. Il contient également des demandes entièrement documentées ; dans l'onglet "Description" de chaque demande, vous trouverez une documentation expliquant ce que fait l'appel, quand l'utiliser, les variables requises (clés API, secrets, JWT) et les réponses attendues.

Cliquez sur le bouton "Run in Postman" pour forker l'espace de travail dans votre propre environnement Postman et tester la collection :

Vous pouvez également télécharger et importer directement nos spécifications OpenAPI en suivant les instructions ci-dessous.

Postman et OpenAPI

Postman prend en charge les documents OpenAPI que nous publions avec toutes nos API.

Installez Postman et suivez les étapes décrites ci-dessous pour essayer très rapidement l'une des API de Vonage. Nous publions un document OpenAPI pour chaque API, et Postman peut le lire et créer une collection de demandes dans lesquelles vous pouvez entrer des valeurs.

Télécharger et importer la spécification OpenAPI

Le moyen le plus simple de trouver le document OpenAPI est de cliquer sur le bouton "Télécharger la spécification OpenAPI 3" dans la référence de l'API que vous souhaitez essayer. Par exemple, visitez la page Verify la page de référence de l'API et cliquez sur le bouton de téléchargement. Vous pouvez le télécharger en .yml ou .json format.

Vous pouvez ensuite suivre ces instructions pour importer le fichier dans Postman.

Faire un appel à l'API

Une fois l'importation effectuée, vous pourrez voir les différents points de terminaison disponibles pour l'API. Par exemple, si vous avez importé la description de l'API Verify, vous pourrez choisir "Demander l'envoi d'une vérification à un utilisateur" dans la barre de navigation de gauche et obtenir une requête prête à l'emploi. Une fois que vous avez mis à jour les en-têtes et le corps avec les informations requises, vous pouvez appuyer sur "Envoyer" et vérifier la réponse de l'API.

Utilisation avancée de Postman

Environnements d'utilisation

Le facteur a un caractéristiques des environnements qui vous permet d'utiliser les mêmes variables (telles que vos identifiants API) dans de nombreuses demandes différentes.

Pour créer un environnement, cliquez sur le bouton des paramètres en haut à droite de l'écran et choisissez "Ajouter". Donnez un nom à votre environnement et ajoutez les variables que vous souhaitez utiliser, telles que :

• api_key
• api_secret
• phone_number

Une fois sauvegardé, vous pouvez, par exemple, saisir {{api_key}} dans vos requêtes au lieu de coller votre clé API. Postman utilisera la valeur de l'environnement actuel.

Vous pouvez avoir plusieurs environnements, ce qui est utile si vous utilisez différentes clés pour différentes choses, ou si vous envoyez des demandes d'API à un outil de débogage ou à un serveur de simulation d'API tel que Prism. Ajoutez autant d'environnements que nécessaire en répétant les étapes ci-dessus et en choisissant l'environnement à utiliser dans le menu déroulant situé dans la partie supérieure droite de l'écran.

Collections du facteur

Pour plus d'informations sur les collections Postman, voir la page Collections du facteur documentation.