Facteur

Nos API peuvent être utilisées avec n'importe quel client HTTP ; choisissez votre préféré ! Nous aimons FacteurIl s'agit d'une interface graphique conviviale pour un puissant client HTTP multiplateforme.

Essayez notre bouton "exécuter dans Postman" pour démarrer rapidement avec nos API les plus utilisées :

Si vous avez besoin de l'une de nos API Beta ou Developer Preview, lisez la suite pour savoir comment utiliser les documents OpenAPI des pages de référence des API avec Postman.

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.

Obtenir la description OpenAPI de l'API

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. Les fichiers sont en .yml format.

Importation de Spec dans Postman

Démarrez Postman et cherchez le bouton "Importer" au-dessus de la barre de gauche. Recherchez le fichier .yml que vous souhaitez utiliser, et choisissez "Ouvrir", puis "Suivant".

Dans la barre latérale de gauche, vous avez maintenant un dossier/collection pour votre API et, à l'intérieur, un modèle de demande pour chacun des points d'extrémité de l'API.

Faire un appel à l'API

Par exemple, si vous avez importé la description de l'API Verify, vous pouvez choisir "Verify Request" dans la barre de gauche et obtenir une demande prête à l'emploi. Allez-y et ajoutez les champs dont vous avez besoin :

• Vos identifiants API ! Pour l'API Verify, il s'agit de l'identifiant API_KEY et API_SECRET et vous pouvez trouver ces détails dans le tableau de bord de votre Account
• Le numéro de téléphone à Verify (n'oubliez pas d'utiliser le format E.164)
• Le nom de la marque qui effectue la vérification (vous pouvez choisir n'importe quoi ici puisque vous ne faites que tester des choses).
• Régler le format dans la section des paramètres du chemin d'accès à json

Appuyez maintenant sur "Envoyer" et vérifiez la réponse de l'API.

Utilisation avancée de Postman

Nous sommes de grands fans de Postman et nous avons donc décidé de partager avec vous nos meilleurs conseils.

Environnements d'utilisation

Le facteur a un caractéristiques des environnements qui est très utile lorsque vous utilisez les mêmes variables (comme les identifiants de votre API) dans plusieurs requêtes 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

Enregistrez les valeurs, puis dans votre requête, au lieu de coller votre clé API, vous pouvez taper {{api_key}} et 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.