Démarrer avec l'interface de programmation de Vonage

La CLI de Vonage comporte de nombreuses commandes qui peuvent s'amorcer avec les API de Vonage. Bien que vous puissiez utiliser le tableau de bord pour accomplir de nombreuses tâches de la CLI, vous pouvez également configurer votre application de façon programmatique sur votre serveur. de nombreuses tâches de l'interface de programmation, vous pouvez également configurer votre application sur votre serveur. Vous avez déjà une Vonage configurée ? La CLI peut vous aider à exporter rapidement la configuration en JSON ou YAML pour l'utiliser dans votre programme. votre programme.

Nouveautés de la version 3

Les personnes qui découvrent l'interface de programmation peuvent sauter cette section. La dernière version 3 de l'interface de programmation offre une conception pragmatique pour pour remédier à certaines lacunes des versions antérieures.

Drapeaux normalisés

Tous les drapeaux de la CLI de Vonage utilisent maintenant caisse à kebabLe système de gestion de l'information de l'Union européenne (UE) permet d'assurer la cohérence et de rendre les commandes plus directes.

Prise en charge des sorties JSON et YAML

Vous pouvez désormais spécifier le format de sortie des commandes à l'aide de JSON ou de YAML, ce qui offre une grande souplesse d'intégration avec vos outils et flux de travail. outils et flux de travail.

Commandes groupées par action

Les commandes sont organisées par action afin d'améliorer la convivialité et de faciliter la recherche des fonctionnalités dont vous avez besoin.

Construit avec yargs

La version 3 est construite à partir de la base en utilisant le logiciel yargs lien et offre une expérience robuste et conviviale. robuste et conviviale.

Une configuration plus facile

La configuration du CLI a été simplifiée pour faciliter le travail au sein d'une application Vonage ou d'un Account Vonage. Voir ci-dessous pour plus d'informations sur la configuration du CLI

Mises à jour automatiques

La version 3 vérifiera périodiquement la présence de nouvelles mises à jour et vous informera du moment de la mise à niveau. Cela vous permettra de vous assurer que vous appelez correctement les API de Vonage et que l'outil est exempt de bogues. que vous appelez correctement les API de Vonage et que l'outil est exempt de bogues.

Installation

Le CLI de Vonage est écrit avec NodeJS et utilise le @vonage/server-sdk lien paquet. L'interface de programmation fonctionnera toujours avec la version la plus basse de Long Term supporté (LTS) version de NodeJS (actuellement 18.20).

Installation avec npm

Pour installer le CLI de Vonage à l'aide de npmExécutez la commande suivante :

npm install -g @vonage/cli

Installation avec le fil

Pour installer le CLI de Vonage à l'aide de yarn,

yarn global add @vonage/cli

Drapeaux mondiaux

Le CLI de Vonage fournit un ensemble de drapeaux globaux qui sont disponibles pour toutes les commandes :

  • --verbose: Imprimer plus d'informations.
  • --debug: Imprime les informations de débogage.
  • --no-color: Désactive la sortie couleur.
  • --help: Afficher l'aide.

verbose et debug les informations seront écrites à l'adresse suivante STDERR pour permettre l'insertion de la sortie dans d'autres programmes

Authentification

Le CLI de Vonage utilise un système de configuration flexible pour gérer les informations d'identification de l'API. Il prend en charge les fichiers de configuration locaux ou globaux et les drapeaux de ligne de commande pour remplacer ces valeurs. fichiers de configuration locaux ou globaux et des drapeaux de ligne de commande pour remplacer ces valeurs, ce qui vous permet d'adapter votre configuration en fonction des besoins de votre projet ou de vos préférences personnelles. les besoins de votre projet ou vos préférences personnelles.

Configuration

L'interface de programmation charge la configuration dans l'ordre suivant :

  1. Drapeaux de la ligne de commande --api-key, --api-secret, --private-keyet --app-id.
  2. Un fichier de configuration local dans le répertoire de travail actuel .vonagerc.
  3. Un fichier de configuration globale dans le répertoire .vonage dans votre répertoire personnel $HOME/.vonage/config.json.

Remarque : Seule l'interface de programmation lira ces valeurs à partir de .vonagerc. Le SDK de Vonage nécessite une initialisation séparée avec ses propres informations d'identification.

Note: Le contenu de la clé privée sera stocké dans le fichier de configuration. Ceci a pour but de s'assurer que la clé n'est pas de s'assurer que la clé n'est pas écrasée lorsque de nouvelles clés sont générées.

Drapeaux:

  • --api-key: La clé API qui se trouve dans la section "Paramètres API" de votre tableau de bord.
  • --api-secret: Le secret de l'API qui se trouve dans la section "Paramètres de l'API" de votre tableau de bord.
  • --app-id: L'identifiant de l'application à utiliser. Elle se trouve dans la section "Applications" du tableau de bord ou est sortie avec l'option vonage apps.
  • --private-key: Le chemin ou le contenu de la clé privée. La clé privée n'est accessible que lors de la création de l'application ou lors de la régénération des clés dans le tableau de bord. ou lorsque vous régénérez les clés dans le tableau de bord.

Définir l'authentification

Bien que vous puissiez utiliser la CLI sans la configurer, il vous sera demandé de transmettre les drapeaux lors de l'exécution d'une commande. L'utilisation de l vonage auth set est recommandée pour vous éviter de les saisir à chaque fois que vous exécutez une commande.

Drapeaux:

Cette commande utilise la fonction drapeaux d'authentification globale

Exemples:

Configurez vos identifiants API Vonage :

vonage auth set `
--api-key='your-api-key' `
--api-secret='your-api-secret' `
--app-id='your-application-id' `
--private-key=C:\path\to\private.key

API Key: your-api-key
API Secret: your-**************
App ID: your-application-id
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

Note: courir vonage auth set ne supprimera pas les valeurs actuelles. Par conséquent, vous pouvez définir uniquement la clé API/le secret ou l'identifiant de l'application/la clé privée individuellement. App ID/Private Key individuellement. Cependant, vous ne pourrez pas définir l'identifiant de l'application et la clé privée sans avoir défini la clé et le secret de l'API. sans avoir défini la clé API et le secret. Ceci est dû à la façon dont la commande vérifie que les informations d'identification sont valides.

Note: Cette commande vérifiera également que les informations d'identification sont correctes avant de valider.

Vérifier l'authentification

Verify that your authentication details are valid. Par défaut, le fichier de configuration globale est utilisé. La vérification des fonctionne comme suit :

  1. La clé et le secret de l'API sont vérifiés en appelant la liste des applications à l'aide de la fonction Applications API.
  2. L'identifiant de l'application et la clé privée sont validés en récupérant les informations relatives à l'application et en utilisant la clé publique en même temps que la clé privée pour s'assurer qu'elles sont correctement appariées.

Remarque : cette commande n'utilise pas les arguments de la ligne de commande. Elle vérifiera uniquement les fichiers de configuration

Drapeaux:

  • --local: Utiliser le fichier de configuration local (.vonagerc).

Exemples:

Vérifiez la configuration globale :

vonage auth check 

Global credentials found at: C:\Users\bob\.vonage\config.json

API Key: abcd1234
API Secret: abc**************
App ID: 00000000-0000-0000-0000-000000000000
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

Vérifier la configuration locale :

vonage auth check --local

Global credentials found at: .vonagerc

API Key: abcd1234
API Secret: abc**************
App ID: 00000000-0000-0000-0000-000000000000
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

Afficher l'authentification

Affichez votre configuration d'authentification actuelle. Cette configuration suit le chargement de la configuration mentionnée ci-dessus et vous permet de savoir quel fichier de configuration est utilisé par l'interface de programmation.

Note: Cette commande permet également de vérifier que les informations d'identification sont correctes.

Drapeaux:

  • --show-all: Afficher la clé privée non expurgée et le secret de l'API.
  • --yaml: Sortie au format YAML.
  • --json: Sortie au format JSON.

Exemples:

Afficher la configuration

vonage auth show

Global credentials found at: C:\Users\bob\.vonage\config.json

API Key: your-api-key
API Secret: your-**************
App ID: your-application-id
Private Key: Is Set

✅ Checking API Key Secret
✅ Checking App ID and Private Key

Utilisation de l'interface de programmation

Visualisation des commandes disponibles

Les commandes sont regroupées par produit ou par action. Pour afficher la liste des commandes disponibles, il suffit d'exécuter la commande vonage sans aucun argument :

vonage 

vonage <command>

Commands:
  vonage apps [command]           Manage applications
  vonage auth [command]           Manage authentication information
  vonage balance                  Check your account balance
  vonage conversations [command]  Manage conversations
  vonage jwt <command>            Manage JWT tokens
  vonage members [command]        Manage applications
  vonage numbers [command]        Manage numbers
  vonage users [command]          Manage users

Options:
      --version   Show version number                                                                                                                                                  [boolean]
  -v, --verbose   Print more information                                                                                                                                               [boolean]
  -d, --debug     Print debug information                                                                                                                                              [boolean]
      --no-color  Toggle color output off                                                                                                                                              [boolean]
  -h, --help      Show help                                                                                                                                                            [boolean]

Besoin d'aide ?

Si vous rencontrez des problèmes ou si vous avez besoin d'aide, rejoignez notre canal Slack de la communauté.