Introdução à CLI da Vonage

A CLI da Vonage possui diversos comandos que permitem instalar e configurar Applications em seu servidor por meio de programação, além de exportar rapidamente a configuração em formato JSON ou YAML para uso em seus programas.

Instalação

A CLI da Vonage foi desenvolvida com Node.js e utiliza o @vonage/server-sdk pacote, que você pode encontrar em GitHub. A CLI sempre funcionará com a versão mais recente com suporte de longo prazo (LTS) versão do Node.js (atualmente 18.20).

Observação: As versões ímpares do Node.js são consideradas experimentais e terão apenas suporte limitado.

Instalação com o npm

Para instalar a CLI da Vonage usando npm, execute o seguinte comando:

npm install -g @vonage/cli

Instalação com fio

Para instalar a CLI da Vonage usando yarn:

yarn global add @vonage/cli

Configuração inicial

O CLI da Vonage utiliza um sistema de configuração flexível para gerenciar suas credenciais de API. Ele oferece suporte a arquivos de configuração locais ou globais e opções de linha de comando para substituir esses valores, permitindo que você personalize sua configuração de acordo com as necessidades do seu projeto ou suas preferências pessoais.

A CLI carregará a configuração na seguinte ordem:

  1. Opções da linha de comando:
  2. Um arquivo de configuração local no diretório de trabalho atual .vonagerc.
  3. Um arquivo de configuração global no .vonage pasta no seu diretório pessoal $HOME/.vonage/config.json.

Observação: Somente a CLI irá ler esses valores de .vonagerc. Os SDKs da Vonage exigem uma inicialização separada com suas próprias credenciais.

Nota: O conteúdo da chave privada será armazenado no arquivo de configuração. Isso foi projetado para ajudar a garantir que a chave não seja sobrescrita quando novas chaves forem geradas

Configurar autenticação

Embora seja possível usar a CLI sem configurá-la, será necessário passar os parâmetros ao executar um comando.

Usando o vonage auth set Recomenda-se usar o comando para evitar ter que digitá-los toda vez que você executar um comando.

Bandeiras

Este comando utiliza os seguintes sinalizadores globais de autenticação:

  • --api-key: A chave de API encontrada na seção “Configurações da API” do seu painel.
  • --api-secret: O segredo da API encontrado na seção “Configurações da API” do seu painel.
  • --app-id: O ID do aplicativo a ser utilizado. Ele pode ser encontrado na seção “Applications” do painel de controle ou é exibido junto com vonage apps.
  • --private-key: O caminho ou o conteúdo da chave privada. A chave privada só pode ser acessada quando o aplicativo é criado ou quando você regenera as chaves no painel de controle.

Ao enviar, o sistema verificará se as credenciais estão corretas antes de confirmar.

Nota: corrida vonage auth set não removerá os valores atuais e só atualizará os arquivos de configuração mediante confirmação do usuário. Portanto, você pode definir apenas a chave de API/segredo ou o ID do aplicativo/chave privada individualmente. No entanto, não será possível definir o ID do aplicativo e a chave privada sem que a chave de API e o segredo estejam configurados.

Exemplos

Para configurar suas credenciais da API da 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

Usando a CLI

Visualizando os comandos disponíveis

Os comandos são agrupados por produto ou ação. Para visualizar uma lista dos comandos disponíveis, basta executar vonage sem nenhum argumento:

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 tunnel <which>           Open a tunnel in order to test webhooks
  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]

Você pode adicionar o --help Digite o sinalizador em qualquer lugar para ver todos os comandos disponíveis e como usá-los.

Bandeiras do mundo

A CLI do Vonage oferece um conjunto de sinalizadores globais que estão disponíveis para todos os comandos:

  • --version: Exibe a versão da CLI que está instalada no momento.
  • --no-color: Desativar a saída em cores.
  • --help: Mostrar ajuda.
  • --yaml: Saída no formato YAML.
  • --json: Saída no formato JSON.

Apenas alguns comandos são compatíveis com os parâmetros YAML e JSON. Você pode usar o --help use o sinalizador com qualquer comando para verificar se ele pode ser utilizado.

Depuração

O --verbose e --debug Os sinalizadores também podem ser usados para exibir informações adicionais sobre o funcionamento da CLI. Consulte o Depuração guia para obter mais detalhes, incluindo códigos de saída.

Precisa de ajuda?

Caso encontre algum problema ou precise de ajuda, entre em contato conosco canal do Slack da comunidade.