Primeros pasos con la CLI de Vonage

La CLI de Vonage tiene muchos comandos que te permiten establecer y configurar aplicaciones en tu servidor mediante programación, así como exportar rápidamente la configuración a JSON o YAML para consumirla en tus programas.

Instalación

La CLI de Vonage está escrita con NodeJS y utiliza el @vonage/server-sdk que encontrará en GitHub. La CLI siempre funcionará con el soporte a largo plazo (LTS) más bajo. versión de NodeJS (actualmente 18.20).

Nota: Los números de versión impares de NodeJS se consideran experimentales y sólo tendrán un soporte limitado.

Instalación con npm

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

Instalación con hilo

Para instalar la CLI de Vonage mediante yarn:

Configuración inicial

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.

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

  1. Banderas de línea de comandos:
  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 por separado con sus propias credenciales.

Nota: El contenido de la clave privada se almacenará dentro del archivo de configuración. Esto está diseñado para ayudar a garantizar que la clave no se sobrescriba cuando se generen nuevas claves.

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

Este comando utiliza los siguientes indicadores de autenticación global:

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

Cuando se envíe, comprobará que las credenciales son correctas antes de comprometerse.

Nota: correr vonage auth set no eliminará los valores actuales, y sólo actualizará los archivos de configuración con la confirmación del usuario. Por lo tanto, puede configurar sólo la clave de API/secreto o el 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.

Ejemplos

Para configurar tus credenciales de API de Vonage:

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:

Puede añadir el --help en cualquier lugar para ver todos los comandos disponibles y cómo utilizarlos.

Banderas mundiales

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

  • --version: Muestra la versión de la CLI que está instalada actualmente.
  • --no-color: Desactiva la salida de color.
  • --help: Mostrar ayuda.
  • --yaml: Salida en formato YAML.
  • --json: Salida en formato JSON.

Sólo algunos comandos son compatibles con las banderas YAML y JSON. Puede utilizar las banderas --help con cualquier comando para ver si se pueden utilizar.

Depuración

En --verbose y --debug flags también se pueden utilizar para mostrar información adicional sobre cómo se está ejecutando la CLI. Véase el Depuración para más detalles, incluidos los códigos de salida.

¿Necesita ayuda?

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