Skip to main content

Autenticação

A API VoiceCheap utiliza chaves de API para autenticação. Todas as solicitações de API devem incluir sua chave de API no cabeçalho x-api-key.

Obtendo sua chave de API

1

Faça login no VoiceCheap

Acesse app.voicecheap.ai e faça login na sua conta.
2

Navegue até a página da API

Vá para a página de API em app.voicecheap.ai/page-api.
3

Gerar chave de API

Clique em Criar Nova Chave e dê um nome a ela. Sua chave de API completa será exibida apenas uma vez - copie e armazene-a com segurança imediatamente.
Importante: Salve sua chave imediatamenteSua chave de API completa é exibida apenas uma vez quando criada. Após fechar o modal, você verá apenas uma versão mascarada (vc_abc...xyz). Se você perder sua chave, deverá excluí-la e criar uma nova.

Limites da chave de API

  • Você pode criar um máximo de 5 chaves de API por conta
  • Cada chave pode ser nomeada para fácil identificação (por exemplo, “Produção”, “Desenvolvimento”)
  • As chaves podem ser excluídas a qualquer momento na página da API

Usando sua chave de API

Inclua sua chave de API no cabeçalho x-api-key em cada solicitação:

Requisitos

Assinatura paga necessáriaO acesso à API requer uma assinatura paga ativa. Contas gratuitas não podem usar a API. Se você tentar usar a API sem uma assinatura válida, receberá um erro 403 Forbidden.

Segurança da chave de API

Mantenha em segredo

Nunca exponha sua chave de API em código do lado do cliente, repositórios públicos ou qualquer local acessível publicamente.

Use variáveis de ambiente

Armazene sua chave de API em variáveis de ambiente ou em um gerenciador de segredos seguro.

Faça a rotação regularmente

Faça a rotação periódica de suas chaves de API, especialmente se suspeitar que elas possam ter sido comprometidas.

Monitore o uso

Acompanhe o uso da sua API para detectar qualquer acesso não autorizado.

Respostas de erro

Se a autenticação falhar, você receberá um dos seguintes erros:

Exemplo de resposta de erro