Démarrer avec le CLI de Vonage

Le CLI de Vonage comporte de nombreuses commandes qui vous permettent de mettre en place et de configurer par programme des applications sur votre serveur, ainsi que d'exporter rapidement la configuration en JSON ou YAML pour la consommer dans vos programmes.

Installation

Le CLI de Vonage est écrit avec NodeJS et utilise le @vonage/server-sdk que vous pouvez trouver sur GitHub. L'interface de programmation fonctionnera toujours avec la version la plus basse du support à long terme (LTS). version de NodeJS (actuellement 18.20).

Remarque : Les numéros de version impairs de NodeJS sont considérés comme expérimentaux et ne bénéficieront que d'une prise en charge limitée.

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

Configuration initiale

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, ce qui vous permet d'adapter votre configuration en fonction des besoins de votre projet ou de vos préférences personnelles.

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

  1. Drapeaux de la ligne de commande :
  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. Les SDK de Vonage nécessitent une initialisation séparée avec leurs propres informations d'identification.

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

Définir l'authentification

Bien que vous puissiez utiliser la CLI sans la configurer, il vous sera demandé d'indiquer les drapeaux lors de l'exécution d'une commande.

L'utilisation de la vonage auth set est recommandée pour vous éviter de les saisir à chaque fois que vous exécutez une commande.

Drapeaux

Cette commande utilise les drapeaux d'authentification globale suivants :

  • --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.

Lorsqu'il est soumis, il vérifie que les informations d'identification sont correctes avant de s'engager.

Note: courir vonage auth set ne supprimera pas les valeurs actuelles et ne mettra à jour les fichiers de configuration qu'avec la confirmation de l'utilisateur. Par conséquent, vous pouvez définir uniquement la clé API/le secret ou l'identifiant de l'application/la clé privée individuellement. Cependant, vous ne pourrez pas définir l'identifiant de l'application et la clé privée sans avoir défini la clé de l'API et le secret.

Exemples

Pour configurer les informations d'identification de l'API de 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

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 tunnel <which>           Open a tunnel in order to test webhooks
  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]

Vous pouvez ajouter le --help n'importe où pour voir toutes les commandes disponibles et comment les utiliser.

Drapeaux mondiaux

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

  • --version: Affiche la version du CLI actuellement installée.
  • --no-color: Désactive la sortie couleur.
  • --help: Afficher l'aide.
  • --yaml: Sortie au format YAML.
  • --json: Sortie au format JSON.

Seules certaines commandes sont compatibles avec les drapeaux YAML et JSON. Vous pouvez utiliser les drapeaux --help avec n'importe quelle commande pour voir si elle peut être utilisée.

Débogage

Les --verbose et --debug Les drapeaux peuvent également être utilisés pour afficher des informations supplémentaires sur le fonctionnement de la CLI. Voir la page Débogage pour plus de détails, y compris les codes de sortie.

Besoin d'aide ?

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