As chaves API permitem conectar com segurança seu site, aplicativo ou outra ferramenta à sua conta Brevo, para que você possa automatizar tarefas como adicionar contatos, enviar campanhas ou exportar dados.

É bom saber

• Apenas o proprietário da conta ou usuários com a permissão de chaves API podem acessar a página API Keys & MCP, criar uma nova chave API ou excluir uma chave API existente. Para saber mais sobre permissões de usuário e níveis de permissão, consulte nosso artigo dedicado Adicionar usuários e atribuir permissões na Brevo.
• Sempre que uma chave API for criada ou excluída da conta, o proprietário da conta receberá uma notificação por e-mail, incluindo detalhes como endereço IP e localização.

O que é uma chave API?

Uma chave API é um código usado para identificar e autenticar um aplicativo ou usuário. Ela atua como um identificador exclusivo e fornece um token secreto para fins de autenticação. Por exemplo, você pode usar uma chave API para conectar seu site ou sistema de informações à Brevo. Isso permitirá que você ative automática e manualmente algumas ações entre os dois.

Com uma chave API, você também pode conectar-se à nossa API para adicionar automaticamente novos contatos, bem como para realizar tarefas mais complexas, como:

• Criar e agendar campanhas a partir da API.
• Exportar usuários que pertençam a listas particulares.
• Exportar estatísticas de campanha etc.

Para acessar a lista completa de comandos que você pode usar com nossa API, consulte a documentação de nossa API.

Onde posso encontrar minhas chaves API?

Para proteger suas chaves API e torná-las mais seguras, as chaves API existentes não são visíveis em sua conta da Brevo. Apenas os últimos dígitos das chaves são exibidos na página API Keys & MCP (Chaves API e MCP) para que você possa distinguir entre várias chaves, se necessário:

É por isso que sugerimos enfaticamente que você armazene sua chave API em um ambiente seguro ao criá-la. Se você perdeu sua chave API, recomendamos criar uma nova, armazená-la em um ambiente seguro e substituir a anterior.

Crie uma chave API

Ao configurar uma integração com sua conta Brevo, você pode precisar criar uma nova chave API:

1. Clique no menu suspenso da sua conta e selecione Settings (Configurações) > SMTP e API > API Keys & MCP (Chaves API e MCP).
2. Clique em Generate new API key (Gerar nova chave API).
   
3. Insira o código de verificação de 6 dígitos enviado para o e-mail da sua conta e clique em Verify (Verificar).
   💡 É bom saber

   Se você não receber o código, poderá reenviá-lo por e-mail ou SMS após 1 minuto.
4. Dê um nome à sua chave API. Ela deve especificar com que integração a chave API será usada, para que você possa reconhecê-la facilmente.
5. Defina uma data de expiração de 7 dias a 1 ano ou escolha sem expiração para a chave API.
   ❗️ Importante

   Escolher No expiration (Sem expiração) significa apenas que a chave não tem uma data de expiração fixa. Isso não a isenta da política de inatividade separada da Brevo:

   • Data de vencimento atingida: você receberá um lembrete por e-mail 3 dias antes e no dia em que a chave expirar.
   • 90 days of inactivity (90 dias de inatividade): mesmo sem data de expiração definida, a chave será desativada se não tiver feito uma chamada API bem-sucedida em 90 dias. Você receberá um lembrete por e-mail 7 dias antes e no dia em que isso acontecer.
6. Clique em Generate (Gerar).
   
7. Copie sua chave API e a armazene em um ambiente seguro.
   
   ❗️ Importante

   Sua chave API só fica visível durante esta etapa. Depois que sua chave API tiver sido criada, você não poderá copiá-la novamente e vai precisar criar uma nova, caso a perca.
   
8. (Opcional) Ative a opção Create MCP server API key (Criar chave API do servidor MCP) para gerar uma versão da chave API permitindo que você conecte um sistema de IA ao Brevo por meio do protocolo MCP. Para saber mais, confira nosso artigo dedicado O que é o Model Context Protocol (MCP)?.
   💡 É bom saber

   Se você ativar a opção Create MCP server API key (Criar chave API do servidor MCP), a chave API criada na etapa 4 será desativada e, em vez disso, será gerada uma versão MCP da chave API.
9. Clique em OK.

Você criou uma nova chave API com sucesso.

Desativar uma chave API

Se você deseja pausar temporariamente o uso de uma chave API em vez de excluí-la completamente, desative-a:

1. Clique no menu suspenso da sua conta e selecione Settings (Configurações) > SMTP e API > API Keys & MCP (Chave API e MCP).
2. Selecione a chave API que deseja desativar.
3. Clique em Deactivate API key (Desativar chave API).
   

Agora você reativou sua chave API.

Para reativar uma chave, selecione-a novamente e clique em Activate API key (Ativar chave API).

Exclusão de uma chave API

Se sua conta tiver sido comprometida ou se não usar mais uma integração que requer uma chave API específica, você pode excluir esta chave:

1. Clique no menu suspenso da sua conta e selecione Settings (Configurações) > SMTP e API > API Keys & MCP (Chave API e MCP).
2. Selecione a chave API que deseja excluir.
3. Clique em Delete API key (Excluir chave API).

Você excluiu sua chave API com sucesso.

Práticas recomendadas com chaves API

Chaves API dão acesso completo à sua conta Brevo e devem ser protegidas da mesma maneira que uma senha. Confira algumas práticas recomendas a se ter em mente ao trabalhar com chaves API:

• Use uma chave API diferente para cada integração e especifique o nome da integração no nome da chave API para saber exatamente qual chave corresponde a cada integração. Assim, se uma chave API for comprometida, você pode exclui-la sem impacto às suas outras integrações.
• Armazene suas chaves API em um ambiente seguro, não em um documento do Word ou post-it.
• Não exponha sua chave API ao público. Certifique-se de ocultar sua chave API ou, melhor ainda, corte-a completamente, em screenshots ou vídeos.
• Nunca envie uma chave API via e-mail, uma vez que isso dará acesso à sua conta Brevo se alguém invadir sua conta de e-mail.
• Sempre exclua as chaves API que não são mais usadas para limitar os riscos de vazamentos.
• Mantenha suas chaves ativas em uso fazendo pelo menos uma chamada API bem-sucedida a cada 90 dias, mesmo sem uma data de expiração definida, para evitar uma desativação inesperada. 
• Ative o bloqueio de endereços IP para que as chamadas API provenientes de endereços IP desconhecidos sejam bloqueadas até que você os autorize. Para saber mais, consulte nosso artigo dedicado Autorizar e bloquear endereços IP para segurança de API e SMTP.

Solucionar problemas com suas chaves API

Se você estiver com problemas com suas chaves API, revise as seguintes dicas de solução de problemas antes de entrar em contato com nossa equipe de suporte.

Minha chave API mostra "Expires: never" (Expira: nunca), mas recebi um aviso de inatividade

Você não selecionou nenhuma data de expiração ao criar sua chave API, mas ainda assim recebeu um aviso por e-mail de que a chave será desativada por inatividade.

Causas e soluções comuns

Verifique a correção

Faça um teste de chamada API usando a chave e verifique na página API Keys & MCP (Chaves API e MCP) se o status dela aparece como ativo.

Se o problema persistir, entre em contato com nossa equipe de suporte e inclua os últimos dígitos da chave e a mensagem de aviso exata que você recebeu.

Recebi um e-mail de segurança "Verificar um novo IP"

Você recebeu um e-mail da Brevo pedindo para confirmar ou negar uma chamada API feita de um endereço IP não reconhecido, e você não tem certeza se é legítimo ou o que fazer em seguida.

Causas e soluções comuns

Verifique a correção

Acesse a página de endereços IP autorizados e confirme se o endereço IP exibe o status esperado (autorizado ou removido).

Se você continuar recebendo alertas de endereços IP que não reconhece após alterar sua chave API, entre em contato com nossa equipe de suporte.

⏭️ O que vem a seguir?

• Autorizar e bloquear endereços IP para segurança de API e SMTP
• Minha conta foi comprometida, o que devo fazer?
• O que é o Model Context Protocol (MCP)?

🤔 Dúvidas?

Em caso de dúvida, sinta-se à vontade para entrar em contato com nossa equipe de suporte, criando um tíquete a partir da sua conta. Caso ainda não tenha uma conta, entre em contato conosco aqui.

Se você está procurando ajuda com um projeto usando o Brevo, podemos encontrar à agência parceira da Brevo certa.