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. Banderas de 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: Sólo 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á dentro del archivo de configuración. Esto es 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 de la API que se encuentra en la sección "Configuración de la API" de su 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 puede utilizar la CLI sin configurarla, se le pedirá que introduzca los indicadores cuando ejecute un comando.

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

Banderas

Esto utiliza las banderas enumeradas anteriormente en Configuración.

Ejemplo

Nota: Correr vonage auth set no eliminará los valores actuales. Por lo tanto, puede configurar sólo la clave de API/secreto o el ID de la aplicación/clave privada individualmente. Sin embargo, no podrá establecer el ID de la aplicación y la clave privada sin haber establecido la clave de API y el secreto. Esto se debe a la forma en que el comando comprueba si las credenciales son válidas.

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

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 haciendo una llamada a la lista de aplicaciones mediante la función 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 Utilice el archivo de configuración local (.vonagerc)

Ejemplo

Compruebe la configuración global:

Compruebe la configuración local:

Mostrar autenticación

Muestra la configuración de autenticación actual. Esto sigue la carga de configuración mencionada sobre 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