Gestion de l'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, ce qui vous permet d'adapter votre configuration en fonction des besoins de votre projet ou de 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. 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. Ceci a été conçu pour s'assurer que la clé n'est pas écrasée lorsque de nouvelles clés sont générées.

Drapeaux

Drapeau Description Type
--app-id L'identifiant de l'application à utiliser. Il se trouve dans la section "Applications" du tableau de bord ou est généré à l'aide de la commande vonage apps. Chaîne
--privateKey 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 lorsque vous régénérez les clés dans le tableau de bord. Chaîne
--apiKey La clé API qui se trouve dans la section "Paramètres API" de votre tableau de bord. Chaîne
--apiSecret Le secret de l'API qui se trouve dans la section "Paramètres de l'API" de votre tableau de bord. Chaîne

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

Elle utilise les drapeaux énumérés ci-dessus dans Configuration.

Exemple

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: Course à pied 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. 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. 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 informations d'identification se déroule 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érifie uniquement les fichiers de configuration.

Drapeaux

Drapeau Description
--local Utiliser le fichier de configuration local (.vonagerc)

Exemple

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

Drapeau Description
--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.

Exemple

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