Primeros pasos con la CLI de Vonage

La CLI de Vonage tiene muchos comandos que pueden arrancar con las API de Vonage. Si bien puedes usar el tablero para realizar muchas tareas de la CLI, también puedes instalar y configurar mediante programación tu aplicación en tu servidor. ¿Ya tienes una aplicación de aplicación de Vonage configurada? La CLI puede ayudarte a exportar rápidamente la configuración a JSON o YAML para consumirla en tu programa.

Novedades de la versión 3

Los nuevos en la CLI pueden saltarse esta sección. La última versión 3 de la CLI ofrece un diseño nuevo y pragmático para abordar algunas de las deficiencias de las versiones anteriores. algunas de las deficiencias de las versiones anteriores.

Banderas normalizadas

Todos los indicadores de la CLI de Vonage utilizan ahora caja de kebabpara garantizar la coherencia y simplificar las órdenes.

Compatibilidad con JSON y YAML

Ahora puede especificar el formato de salida de los comandos mediante JSON o YAML, lo que proporciona flexibilidad para integrarse con sus herramientas y flujos de trabajo.

Comandos agrupados por acción

Los comandos están organizados por acción para mejorar la usabilidad y facilitar la búsqueda de la funcionalidad que necesita.

Construido con yargs

La versión 3 se ha creado desde cero con el programa yargs enlace que proporciona una experiencia y fácil de usar.

Configuración más sencilla

La configuración para la CLI se ha simplificado para que sea más fácil trabajar dentro de una aplicación de Vonage o una Vonage Account. Ver más abajo para obtener más información sobre cómo configurar la CLI

Actualizaciones automáticas

La versión 3 buscará periódicamente nuevas actualizaciones y le informará de cuándo debe actualizar. Esto garantizará que las API de Vonage correctamente y que la herramienta no tenga errores.

Instalación

La CLI de Vonage está escrita con NodeJS y utiliza el @vonage/server-sdk enlace paquete. La CLI siempre funcionará con el paquete Long Term Soportado (LTS) versión de NodeJS (actualmente 18.20).

Instalación con npm

Para instalar la CLI de Vonage mediante npmejecute el siguiente comando:

npm install -g @vonage/cli

Instalación con hilo

Para instalar la CLI de Vonage mediante yarn,

yarn global add @vonage/cli

Banderas mundiales

La CLI de Vonage ofrece un conjunto de indicadores globales que están disponibles para todos los comandos:

  • --verbose: Imprimir más información.
  • --debug: Imprime información de depuración.
  • --no-color: Desactiva la salida de color.
  • --help: Mostrar ayuda.

verbose y debug la información se escribirá en STDERR para poder transferir la salida a otros programas

Autenticación

La CLI de Vonage utiliza un sistema de configuración flexible para administrar tus credenciales de API. Admite archivos de configuración globales y los 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. 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 se hace para que la clave no se sobrescriba cuando se generen nuevas claves.

Banderas:

  • --api-key: La clave de API que se encuentra en la sección "Configuración de API" de su panel de control .
  • --api-secret: El secreto de la API que se encuentra en la sección "Configuración de la API" de su panel de control.
  • --app-id: ID de la aplicación que se va a utilizar. Se encuentra en la sección "Applications" del cuadro de mandos o con vonage apps.
  • --private-key: La ruta o el contenido de la clave privada. Sólo se puede acceder a la clave privada cuando la aplicación o cuando se regeneran las claves en el panel de control.

Establecer autenticación

Aunque puede utilizar la CLI sin configurarla, se le pedirá que introduzca los indicadores cuando ejecute un comando. Si utiliza los indicadores vonage auth set para evitar tener que escribirlos cada vez que se ejecuta un comando.

Banderas:

Este comando utiliza la función indicadores de autenticación global

Ejemplos:

Configura tus credenciales de 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

Nota: correr vonage auth set no eliminará los valores actuales. Por lo tanto, puede establecer sólo la API Key/Secret o ID de aplicación/clave privada individualmente. Sin embargo, no podrá configurar el ID de la aplicación y la clave privada sin haber configurado la clave y el secreto de la API. 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:

  • --local: Utilice el archivo de configuración local (.vonagerc).

Ejemplos:

Compruebe 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 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:

  • --show-all: Mostrar la clave privada no redactada y el secreto de la API.
  • --yaml: Salida en formato YAML.
  • --json: Salida en formato JSON.

Ejemplos:

Mostrar la configuración

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

Uso de la CLI

Visualización de comandos disponibles

Los comandos están agrupados por producto o acción. Para ver una lista de los comandos disponibles, basta con ejecutar vonage sin argumentos:

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]

¿Necesita ayuda?

Si tiene algún problema o necesita ayuda, únase a nuestro canal Slack de la comunidad.