Pular para o conteúdo

Criar uma chave de API

A chave de API é a credencial que o seu sistema envia em cada requisição para provar que fala em nome da sua conta. Ela dá acesso amplo à conta — trate-a como uma senha.

  1. Abra o painel de um serviço que tenha o item Chaves de API no menu — SMTP, Marketing, Validador de E-mail ou Prospecção. A chave vale para a conta, não só para aquele serviço.
  2. Vá em Chaves de API e clique em Nova chave.
  3. Em Nome da chave, identifique onde ela será usada — por exemplo, ERP produção.
  4. Em Validade, escolha 90, 180 ou 360 dias.
  5. Clique em Criar chave.
  6. Na tela seguinte, copie o Token com o botão Copiar e guarde-o num cofre de senhas ou na configuração segura do seu sistema.
  • O token vai no cabeçalho de cada requisição:

    Authorization: Bearer SEU_TOKEN
  • A chave para de funcionar na data de validade. Antes disso, crie uma nova, troque no seu sistema e só então pare de usar a antiga.

  • Use a chave só no servidor. Nunca a coloque em código que roda no navegador ou em aplicativo, nem em repositório de código.
  • Crie uma chave por sistema: fica fácil saber qual sistema usa qual chave.
  • Prefira a menor validade que funcione para você.
Sintoma Causa provável O que fazer
A API responde 401 — “Credencial de acesso ausente, inválida ou expirada” Chave vencida, copiada pela metade, ou sem o Bearer antes Confira o cabeçalho Authorization: Bearer SEU_TOKEN; se a chave venceu, crie outra
A API responde 422 — “Você não possui um plano ativo…” A conta não tem plano ativo do serviço Confira a assinatura no portal do cliente
A API responde 429 — “Muitas tentativas” Limite de requisições por minuto atingido Espere o tempo indicado no cabeçalho Retry-After e reduza o ritmo
A chave vazou Ela foi exposta em código, log ou mensagem Abra um chamado no portal do cliente imediatamente, em Suporte → Abrir Chamado