https://d226lax1qjow5r.cloudfront.net/blog/blogposts/announcing-the-vonage-apis-postman-collection/Blog_Postman_1200x600.png

Annonce de la collection Postman des API de Vonage

Publié le May 11, 2021

Temps de lecture : 2 minutes

Chez Vonage, nous publions les spécifications OpenAPI pour toutes nos API. Ces spécifications permettent à notre communauté de développeurs d'explorer, d'évaluer et d'intégrer efficacement les API de Vonage.

Comme Lorna l'a mentionné dans son article sur l'évaluation des API à l'aide d'OpenAPI l'évaluation des API à l'aide d'OpenAPIle téléchargement d'un OpenAPI Spec et de l'explorer dans Postman est un excellent moyen de se familiariser avec de nouvelles API.

Je suis tout à fait d'accord ! Si vous ne connaissez pas encore Postmanil s'agit d'une interface graphique conviviale pour un puissant client HTTP multiplateforme que je vous encourage à essayer.

Nous sommes heureux d'annoncer que l'exploration des API de Vonage est devenue encore plus rapide et plus facile ! Nous avons ajouté un bouton "Exécuter dans Postman" à la page Postman sur notre portail de développementVous n'êtes donc plus qu'à quelques clics de faire votre première demande.

Il peut également être découvert sur le réseau réseau principal de Postman si vous préférez y naviguer.

Une fois que vous avez cliqué sur le bouton Exécuter dans Postman vous serez dirigé vers l'instance Postman de votre choix, et tous les appels API de Vonage vous attendront, joliment organisés dans une collection.

Vonage APIs Postman collection imported view

L'avantage de l'utilisation d'une collection Postman est que nous pouvons préparer les requêtes pour vous, de sorte que les appels à l'API ne nécessitent qu'un minimum de travail.

Il possède également quelques fonctionnalités intéressantes, comme la possibilité de configurer des variables d'environnement. Cette collection est livrée avec un Environnement Vonage qui répertorie les API_KEY, API_SECRETet JWTqui sont les paramètres les plus couramment utilisés, mais n'hésitez pas à en ajouter d'autres au fur et à mesure. Vous pouvez trouver les environnements en cliquant sur l'icône en forme de roue dentée dans le coin supérieur droit.

Vonage environment variables in Postman Collection

Pour ajouter vos informations d'identification, mettez à jour les valeurs actuelles de API_KEY et de API_SECRET avec la clé et le secret de l'API qui se trouvent dans votre tableau de bord Vonage (il n'est pas nécessaire de configurer JWT pour le moment).

Utilisation de la collection Postman des API de Vonage

Ensuite, examinons de plus près l'utilisation de la collection Postman des API de Vonage pour explorer l'API Numbers API.

Développez le dossier de la collection et trouvez le fichier Numbers à l'intérieur.

Numbers requests in Vonage APIs Postman collection

L'API Numbers de Vonage vous permet de gérer votre inventaire de numéros virtuels de manière programmatique. Pour en savoir plus sur les opérations disponibles, assurez-vous de consulter la Référence de l'API Numbers.

Pour cet exemple, essayons la fonction Lister les numéros que vous possédez entrée.

Votre api_key et api_secret seront tirés dynamiquement de l'environnement Vonage, vérifiez donc que vous avez défini ces valeurs dans l'environnement, puis cliquez sur envoyer.

Numbers API List numbers you own response body

Et voilà ! Vous avez réussi à faire votre première demande d'API Vonage à l'aide de notre collection Postman !

Essayez, amusez-vous et dites-nous ce que vous en pensez !

Quelle est la prochaine étape ?

Partager:

https://a.storyblok.com/f/270183/372x373/36054b72d0/julia-biro.png
Julia BiroDéfenseur des développeurs

Julia s'engage à aider ses collègues développeurs en créant des tutoriels, des guides et des ressources pratiques. Grâce à son expérience en matière de sensibilisation et d'éducation, elle vise à rendre la technologie plus accessible et à améliorer l'expérience globale des développeurs. Vous pouvez souvent la trouver lors d'événements communautaires locaux.