Travailler avec les API de Vonage

Bienvenue sur la plateforme API de Vonage ! Vonage fournit une suite d'API qui vous permet de communiquer avec vos clients en utilisant vos canaux préférés.

Ce site fournit une documentation complète pour toutes nos API et vous trouverez tout ce que vous devez savoir sur l'utilisation d'une API particulière dans la section correspondante.

Cependant, il existe des concepts fondamentaux que vous devez comprendre et des outils qui peuvent vous aider et qui s'appliquent à toutes nos API :

Ouverture d'un compte

Pour utiliser nos API, vous devez ouvrir un compte. Vous obtiendrez ainsi une clé API et un secret que vous pourrez utiliser pour accéder à nos API.

Accès au tableau de bord du développeur

Une fois que vous avez un Account, vous pouvez vous connecter à la page d'accueil de la Tableau de bord du développeur. Le tableau de bord du développeur est une approche basée sur l'interface graphique pour gérer votre Account, où vous pouvez :

Voir votre clé et votre secret API. Vous en aurez besoin pour authentifier vos demandes auprès de nos API.
Gérer le solde de votre Account. L'accès à nos API est facturé à la demande. Nous vous offrons un crédit gratuit lors de la première ouverture de votre Account et vous pouvez compléter lorsque vous êtes à court d'argent.
Louer des Numbers virtuels. Vous pouvez utiliser Numbers virtuels fourni par Vonage pour envoyer et recevoir des appels et des messages. Voir aussi louer un numéro virtuel.
Gérer les applications. Certaines de nos API (telles que Voice et Messages) requièrent la création d'un fichier Applicationsqui sert de conteneur pour les informations relatives à la sécurité et à la configuration. Vous pouvez créer et gérer ces applications dans le tableau de bord du développeur.
Gérer votre Account. Vous pouvez effectuer autres tâches administratives ici.

Utilisation de la CLI de Vonage

Vous pouvez éventuellement effectuer de nombreuses tâches du tableau de bord à partir de la ligne de commande, en utilisant le CLI de Vonage. C'est souvent plus rapide et cela vous permet également de programmer ces opérations.

Le CLI de Vonage est écrit avec oclif et peut être installé à l'aide du gestionnaire de paquets Node (npm). Les README dans le Vonage CLI GitHub repo vous montre comment installer et utiliser le CLI de Vonage.

Authentification

Lorsque vous utilisez les API de Vonage, vos demandes doivent être authentifié. Généralement, cette opération est réalisée à l'aide de Authentification de base ou JWTs. Vous pouvez générer un JWT approprié à l'aide du CLI de Vonage, ou de notre logiciel outil en ligne. Tout en Authentification de base fonctionnera, mais il ne vous permettra pas de recevoir des webhooks - ceux-ci ne peuvent être activés que par l'utilisation de JWTs.

Si vous utilisez l'authentification silencieuse avec Verify, il doit s'agir du premier canal dans le tableau des flux de travail.

Expérimenter nos API

En fin de compte, vous voudrez créer une application dans votre le langage de programmation choisi. Mais pour commencer, vous voudrez peut-être faire quelques requêtes types à nos API pour vérifier que vous avez fourni les bons paramètres et que vous obtenez les réponses que vous souhaitez.

Si vous connaissez l'outil de ligne de commande BoucleVous y trouverez des extraits Curl pour chacune de nos API que vous pouvez copier, coller et modifier.

Facteur

Il existe plusieurs outils graphiques plus faciles à utiliser que Curl. Un outil populaire est Facteur. Lisez notre guide sur utiliser Postman pour travailler avec nos API. Vonage fournit également un ensemble de Collections du facteurqui permet de commencer à utiliser les API immédiatement.

OpenAPI

Chacune de nos API possède son propre Spécification OpenAPI. Pour en savoir plus sur OpenAPI, consultez notre site Web la documentation. Nos spécifications sont conformes à la version 3 de la spécification OpenAPI, également connue sous le nom d'OAS3.

Utilisation d'un SDK serveur

Lorsque vous serez prêt à créer votre application, vous voudrez utiliser l'un de nos SDK de serveur au lieu de coder chaque requête à la main. Vous trouverez des liens vers tous nos SDK sur la page Outils page.

Travailler avec des Webhooks

Une fois que vous avez appris à faire des demandes à nos API pour passer des appels, envoyer des messages et ainsi de suite, vous voudrez apprendre à recevoir des communications entrantes sur votre numéro virtuel.

Lorsque nos API veulent informer votre application de quelque chose - qu'il s'agisse d'un appel ou d'un message entrant ou d'une mise à jour d'état - elles exigent que votre application expose un point de terminaison URL auquel notre plateforme peut adresser une requête. Ces URL doivent être accessibles sur l'internet public.

Ces points de terminaison sont appelés "Webhooks". En savoir plus sur les webhooks. Une fois que vous avez créé votre crochet web, vous devez indiquer à notre plateforme API de l'utiliser. La procédure à suivre dépend de l'API que vous utilisez et vous trouverez des instructions complètes dans la documentation de cette API.

Rendre ces webhooks accessibles au public pendant le développement peut s'avérer délicat, c'est pourquoi nous recommandons l'utilisation d'un outil appelé Ngrok.

Consultez notre guide sur tester avec Ngrok pour apprendre à l'utiliser.

Format des numéros

Dans les API de Vonage, tous les numéros de téléphone sont dans le format Format E.164. Cela signifie que les Numbers :

Omettre à la fois le début et la fin de l'article + et le code d'accès international tel que 00 ou 001.
Ne pas contenir de caractères spéciaux, tels que des espaces, () ou -

Par exemple, un numéro américain aurait le format suivant 14155550101. Un numéro britannique aurait le format suivant 447700900123.

Si vous n'êtes pas sûr de la manière de formater le nombre, le bouton Number Insight API peut être utilisé pour trouver des informations correctes sur un nombre.

Voir aussi Format des nombres dans la documentation de Voice API.

Concepts

Il existe un certain nombre de concepts partagés entre les API de Vonage : l'utilisation de JSON Web Tokens (JWT), les demandes signées et les webhooks. Les guides ci-dessous expliquent en détail comment utiliser ces éléments.

Applications - Informations de sécurité et de configuration dont vous avez besoin pour vous connecter aux points d'extrémité de Vonage.
Authentification - clés d'API et jetons Web JSON (JWT).
Signer des messages - comment signer cryptographiquement des messages et vérifier les signatures de messages.
Crochets Web - L'API de Vonage peut renvoyer des données à votre serveur Web par l'intermédiaire d'un crochet Web.
OpenAPI - Toutes les API de Vonage ont des descriptions OpenAPI dont vous pouvez tirer parti dans votre propre processus de développement.
Glossaire - Un glossaire des termes courants utilisés dans la plateforme Vonage.

Que faire ensuite ?

Ce guide vous a présenté certains des concepts et outils fondamentaux que vous devez connaître lorsque vous travaillez avec nos API.

Une fois que vous avez compris ces concepts fondamentaux et que vous avez installé les outils que vous avez l'intention d'utiliser, vous êtes prêt à commencer à construire ! Voir la page la documentation de l'API choisie pour commencer.

Si vous rencontrez des difficultés, consultez notre Communauté SlackVous pouvez également consulter notre base de connaissances et demander de l'aide si nécessaire à l'adresse suivante notre site d'assistance.