Configurações da API

A página “Configurações da API” permite que você gerencie suas credenciais de API, configure webhooks e controle o comportamento da SMS API. Cada chave de API possui seu próprio conjunto de credenciais e configurações.

Acessar as configurações da API

1. Faça login no seu Painel de Controle da Vonage
2. Acesse Configurações → Configurações da API na barra lateral esquerda.
3. Selecione uma chave de API na parte superior.

Depois de selecionar uma chave de API,

Chave e segredo da API

Seu Chave de API é exibido na parte superior da página, no menu suspenso da Account. Trata-se de um identificador público utilizado em solicitações de API. Você também pode atribuir um apelido a ele para identificá-lo em toda a plataforma (por exemplo, “Produção”, “Desenvolvimento”, “Teste”).

Seu Segredos da API são apresentados no Chave secreta da API seção:

• Segredo da API 1 - Seu segredo de autenticação primário (ocultado por padrão)
• Segredo da API 2 - Sua senha secundária para a rotação (oculta por padrão)

Se você ainda não tiver um segundo segredo de API, poderá criar um aqui clicando no link “criar novo segredo”.

Tipo de API de mensagens

Configure como a Vonage lida com mensagens SMS para esta chave de API.

A Vonage possui duas SMS API diferentes para o envio de SMS. Você só pode usar uma de cada vez, pois isso altera o formato dos webhooks que você recebe.

Escolha sua API:

• SMS API - API legada com formato de webhook mais simples (GET ou POST)
• Messages API - API multicanal moderna com webhooks em JSON

Clique no botão correspondente para selecionar a API que deseja usar.

SMS API

Formato do webhook

Apenas para a SMS API, selecione o formato dos webhooks de comprovante de entrega (DLR):

1. Clique no Formato do webhook menu suspenso.
2. Escolha entre:
   • OBTER - Dados do webhook enviados como parâmetros de consulta da URL
   • POST - Dados do webhook enviados como corpo codificado como formulário
   • POST-JSON - Dados do webhook enviados como corpo JSON (recomendado)

Webhooks de recibos de entrega (DLR)

Receba atualizações sobre o status de entrega das mensagens SMS enviadas.

1. No Webhooks de recibos de entrega (DLR) No campo, insira a URL do seu webhook.
2. Exemplo: https://example.com/webhooks/delivery-receipt
3. Quando uma mensagem SMS é entregue (ou falha), a Vonage envia uma atualização para esta URL.

Para obter detalhes sobre a carga útil do webhook, consulte o Referência sobre Webhooks da SMS API.

Webhooks para SMS recebidas

Receba notificações quando alguém enviar um SMS para o seu número da Vonage.

1. No Webhooks de SMS recebidos No campo, insira a URL do seu webhook.
2. Exemplo: https://example.com/webhooks/inbound-sms
3. Quando alguém envia uma mensagem de texto para o seu número da Vonage, a mensagem é encaminhada para este URL.

Para obter detalhes sobre a carga útil do webhook, consulte o Referência de mensagens recebidas da SMS API.

Messages API

Webhooks de status

Receba atualizações de status das mensagens enviadas.

1. No Webhooks de status No campo, insira a URL do seu webhook.
2. Exemplo: https://example.com/webhooks/status-updates
3. Quando o status de uma mensagem que você enviou é alterado, a Vonage envia uma atualização para esta URL.

Para obter detalhes sobre a carga útil do webhook, consulte o Referência sobre Webhooks da Messages API.

Webhooks de entrada

Receba notificações quando um cliente enviar uma mensagem para você.

1. No Webhooks de entrada No campo, insira a URL do seu webhook.
2. Exemplo: https://example.com/webhooks/inbound-message
3. Quando alguém lhe envia uma mensagem por meio de qualquer um dos seus canais da Messages API, a mensagem é encaminhada para esta URL.

Para obter detalhes sobre a carga útil do webhook, consulte o Messages API: Referência de Mensagens Recebidas.

Webhooks assinados

Adicione uma camada opcional de segurança para verificar se as solicitações de webhook vêm da Vonage e não foram adulteradas durante o trânsito.

Segredo da Assinatura

Uma chave secreta usada para gerar a assinatura incluída nas solicitações de webhook.

1. No Webhooks assinados seção, visualize seu Segredo de assinatura (ocultado por padrão).
2. Clique no ícone de olho para revelar o segredo.
3. Clique no ícone de cópia para copiá-lo para a área de transferência.

Método de assinatura

Escolha o algoritmo usado para criar a assinatura do webhook:

1. Clique no Método de assinatura menu suspenso.
2. Escolha entre:
   • Assinatura HASH MD5 (versão antiga, não recomendada)
   • Assinatura HMAC com MD5
   • Assinatura HMAC SHA1
   • Assinatura HMAC SHA-256 (recomendado)
   • Assinatura HMAC SHA-512 (o mais seguro)

Quando ativado, as solicitações de webhook recebidas incluem um token JWT no cabeçalho de autorização, que é assinado com seu segredo de assinatura. Saiba mais sobre validação de webhooks assinados.

Conformidade

Números da HIPAA

Se sua conta estiver habilitada para a compra de números em conformidade com a HIPAA, você verá o seguinte aviso:

Entre em contato com o gerente de account da Vonage caso precise habilitar a conformidade com a HIPAA para o seu caso de uso.