Gerenciamento da 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:

  1. Opções de linha de comando --api-key, --api-secret, --private-key, e --app-id.
  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 inicialização separada com suas próprias credenciais.

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

Bandeiras

Bandeira Descrição Tipo
--app-id O ID do aplicativo a ser utilizado. Ele pode ser encontrado na seção “Applications” do painel de controle ou é exibido com vonage apps. String
--privateKey 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. String
--apiKey A chave de API encontrada na seção “Configurações da API” do seu painel. String
--apiSecret O segredo da API, que pode ser encontrado na seção “Configurações da API” do seu painel. String

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

Isso utiliza os sinalizadores listados acima em Configuração.

Exemplo

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:

  1. 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.
  2. 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

Bandeira Descrição
--local Use o arquivo de configuração local (.vonagerc)

Exemplo

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

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

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

Bandeira Descrição
--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.

Exemplo

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