Gestión de la autenticación

La CLI de Vonage utiliza un sistema de configuración flexible para administrar tus credenciales de API. Es compatible con archivos de configuración locales o globales y con indicadores de línea de comandos para anular estos valores, lo que te permite adaptar tu configuración según las necesidades de tu proyecto o tus preferencias personales.

Configuración

La CLI cargará la configuración en el siguiente orden:

  1. Opciones de la línea de comandos --api-key, --api-secret, --private-keyy --app-id.
  2. Un archivo de configuración local en el directorio de trabajo actual .vonagerc.
  3. Un archivo de configuración global en .vonage en su directorio personal $HOME/.vonage/config.json.

Nota: Solo la CLI leerá estos valores de .vonagerc. Los SDK de Vonage requieren una inicialización independiente con sus propias credenciales.

Nota: El contenido de la clave privada se almacenará en el archivo de configuración. Esto se ha diseñado así para garantizar que la clave no se sobrescriba cuando se generen nuevas claves.

Banderas

Bandera Descripción Tipo
--app-id ID de la aplicación que se va a utilizar. Se encuentra en la sección "Applications" del panel de control o se obtiene con vonage apps. Cadena
--privateKey La ruta o el contenido de la clave privada. Solo se puede acceder a la clave privada cuando se crea la aplicación o cuando se regeneran las claves en el panel de control. Cadena
--apiKey La clave API que se encuentra en la sección «Configuración de la API» de tu panel de control. Cadena
--apiSecret El secreto de la API se encuentra en la sección "Configuración de la API" de su panel de control. Cadena

Establecer autenticación

Aunque puedes utilizar la CLI sin configurarla, tendrás que indicar los parámetros al ejecutar un comando.

Utilización de la vonage auth set para evitar tener que escribirlos cada vez que se ejecuta un comando.

Banderas

Esto utiliza los indicadores enumerados anteriormente en Configuración.

Ejemplo

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

Nota: Correr vonage auth set No eliminará los valores actuales. Por lo tanto, puedes configurar solo la clave y el secreto de la API, o el ID de la aplicación y la clave privada, de forma individual. Sin embargo, no podrás configurar el ID de la aplicación y la clave privada sin haber configurado previamente la clave y el secreto de la API. Esto se debe a la forma en que el comando comprueba la validez de las credenciales.

Nota: Este comando también comprobará que las credenciales sean correctas antes de realizar la confirmación.

Comprobar autenticación

Verify that your authentication details are valid. Por defecto, se utilizará el archivo de configuración global. La comprobación de credenciales funciona de la siguiente manera:

  1. La clave y el secreto de la API se comprueban realizando una llamada para obtener la lista de aplicaciones que utilizan el Aplicaciones API.
  2. El ID de la aplicación y la clave privada se validan obteniendo la información de la aplicación y utilizando la clave pública junto con la clave privada para garantizar que se emparejan correctamente.

Nota: Este comando no utilizará los argumentos de la línea de comandos. Sólo comprobará los archivos de configuración.

Banderas

Bandera Descripción
--local Utiliza el archivo de configuración local (.vonagerc)

Ejemplo

Comprueba la configuración global:

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

Compruebe la configuración local:

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

Mostrar autenticación

Muestra tu configuración de autenticación actual. Esto viene a continuación de la carga de la configuración mencionada arriba y le permite saber qué archivo de configuración está utilizando la CLI.

Nota: Este comando también comprobará que las credenciales son correctas.

Banderas

Bandera Descripción
--show-all Mostrar la clave privada no redactada y el secreto de la API.
--yaml Salida en formato YAML.
--json Salida en formato JSON.

Ejemplo

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