Introdução ao Vonage CLI
A CLI da Vonage possui diversos comandos que podem ser integrados às APIs da Vonage. Embora seja possível usar o painel de controle para realizar muitas tarefas da CLI, você também pode instalar e configurar seu aplicativo no servidor por meio de programação. Já tem um aplicativo da Vonage configurado? A CLI pode ajudá-lo a exportar rapidamente a configuração em JSON ou YAML para ser utilizada em seu programa.
Novidades da versão 3
Quem ainda não tem familiaridade com a CLI pode pular esta seção. A versão 3 mais recente da CLI apresenta um design totalmente novo e pragmático para superar algumas das deficiências das versões anteriores.
Bandeiras padronizadas
Todas as opções da CLI da Vonage agora usam caixa de kebab, garantindo a consistência e tornando os comandos mais simples.
Suporte à saída em JSON e YAML
Agora você pode especificar o formato de saída dos comandos usando JSON ou YAML, o que oferece flexibilidade para integrar com suas ferramentas e fluxos de trabalho.
Comandos agrupados por ação
Os comandos são organizados por ação para melhorar a usabilidade e facilitar a localização da funcionalidade de que você precisa.
Criado com o Yargs
A versão 3 foi desenvolvida do zero utilizando o yargs link pacote, que oferece uma experiência robusta e
fácil de usar.
Configuração mais fácil
A configuração da CLI foi simplificada para facilitar o trabalho dentro de um aplicativo da Vonage ou do Account da Vonage. Veja abaixo para obter mais informações sobre como configurar a CLI
Atualizações automáticas
A versão 3 verificará periodicamente se há novas atualizações e informará quando for necessário atualizar. Isso garantirá que você esteja chamando as APIs da Vonage corretamente e que a ferramenta esteja livre de erros.
Instalação
A CLI da Vonage foi desenvolvida com Node.js e utiliza o @vonage/server-sdk
link pacote. A CLI sempre funcionará com a versão mais recente com
Suporte de Longo Prazo (LTS) versão do Node.js (atualmente 18.20).
Instalação com o npm
Para instalar a CLI da Vonage usando npm, execute o seguinte comando:
npm install -g @vonage/cli
npm install -g @vonage/cli
Instalação com fio
Para instalar a CLI da Vonage usando yarn,
yarn global add @vonage/cli
yarn global add @vonage/cli
Bandeiras do mundo
A CLI do Vonage oferece um conjunto de sinalizadores globais que estão disponíveis para todos os comandos:
--verbose: Imprimir mais informações.--debug: Exibir informações de depuração.--no-color: Desativar a saída em cores.--help: Mostrar ajuda.
verbose e debug as informações serão gravadas em STDERR para permitir o redirecionamento da saída para outros programas
Autenticação
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.
Configuração
A CLI carregará a configuração na seguinte ordem:
- Opções de linha de comando
--api-key,--api-secret,--private-key, e--app-id. - Um arquivo de configuração local no diretório de trabalho atual
.vonagerc. - Um arquivo de configuração global no
.vonagepasta 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 planejado para ajudar a garantir que a chave não seja sobrescrita quando novas chaves forem geradas
Bandeiras:
--api-key: A chave de API que se encontra na seção “Configurações de API” do seu painel de controle.--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 comvonage 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.
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 o sinalizadores de autenticação globais
Exemplos:
Configure 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
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: corrida vonage auth set não removerá os valores atuais. 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 definidos. Isso se deve à forma como o comando verifica a validade das credenciais.
Nota: Esse comando também verificará se as credenciais estão corretas antes de confirmar a operação.
Verificar autenticação
Verifique se seus dados de autenticação estão válidos. Por padrão, será utilizado o arquivo de configuração global. A verificação das credenciais funciona da seguinte maneira:
- A chave e o segredo da API são verificados por meio de uma chamada para listar as Applications que utilizam o API de aplicativos.
- O ID do aplicativo e a chave privada são validados por meio da obtenção das informações do aplicativo e do uso da chave pública juntamente com a chave privada, a fim de garantir que estejam emparelhadas corretamente.
Observação: Este comando não utilizará os argumentos da linha de comando. Ele verificará apenas os arquivos de configuração
Bandeiras:
--local: Use o arquivo de configuração local (.vonagerc).
Exemplos:
Verifique a configuração 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
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
Verifique a configuração 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
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 autenticação
Exiba sua configuração de autenticação atual. Isso ocorre após o carregamento da configuração mencionado acima e informa qual arquivo de configuração a CLI está usando.
Nota: Esse comando também verificará se as credenciais estão corretas.
Bandeiras:
--show-all: Mostrar a chave privada e o segredo da API sem censura.--yaml: Saída no formato YAML.--json: Saída no formato JSON.
Exemplos:
Mostrar a configuração
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
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
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]
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]
Precisa de ajuda?
Caso encontre algum problema ou precise de ajuda, entre em contato conosco canal do Slack da comunidade.