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. Você decide exatamente o que cada chave pode acessar.

É 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 (Chaves API e 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 o endereço IP e a localização.
• Para ver todos os comandos que você pode usar com nossa API, consulte a documentação da nossa API.

Criar uma chave API

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

1. Clique no menu suspenso da sua conta e selecione Settings (Configurações) > SMTP e API > API Keys & MCP (Chave API e MCP).
2. Clique em Generate API key (Gerar chave API).
   
3. Digite o código de verificação enviado para o seu dispositivo e clique em Verify (Verificar). Para saber mais, consulte nosso artigo dedicado Verificar sua identidade para ações confidenciais na Brevo.
4. Em Key name (Nome da chave), forneça um nome à sua chave API. Certifique-se de que o nome especifique qual integração a usará para que você possa reconhecê-la facilmente.

5. Em Expiry (Expiração), selecione por quanto tempo a chave permanecerá válida, de 7 dias a 1 ano – ou escolha sem expiração.

   

   ❗️ Importante

   Mesmo sem data de expiração, 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. Se você definir uma data de expiração, também receberá um lembrete 3 dias antes e no dia em que a chave expirar.

6. Em Access (Acesso), escolha quanto da sua conta a chave API pode acessar:

   Restricted (Restrita) [Recomendado] Full (Total)

   Com permissão Restricted (Restrita), a chave só poderá acessar os recursos que você escolher.

   Em Permissions (Permissões), selecione None (Nenhuma), Read (Leitura), Read/write (Leitura/gravação) ou All (Total) para cada recurso que a chave precisa. Para saber mais, consulte nosso artigo dedicado Sobre as permissões de chave API.

   

   Com permissões Full (Totais), a chave pode acessar todos os recursos atuais e futuros, portanto, não há permissões para definir.

   

7. Copie sua chave API e armazene-a 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 precisará criar uma nova, caso a perca.
8. (Opcional) Para gerar uma versão da chave API que permite conectar um sistema de IA à Brevo via protocolo MCP:
   1. Ative Create MCP server API key (Criar chave API do servidor MCP). A chave API padrão será desativada e, em vez disso, será gerada uma versão MCP da chave API.
   2. Copie a chave API MCP.
      
      Para saber mais, confira nosso artigo dedicado O que é o Model Context Protocol (MCP)?. 
9. Clique em I've saved my key (Eu salvei minha chave).

Você criou uma nova chave API com sucesso.

Ver suas chaves API

Para proteger suas chaves API, as chaves existentes não ficam visíveis em sua conta Brevo. A página API Keys & MCP (Chaves API e MCP) só exibe os últimos dígitos de cada chave para que você possa distinguir várias chaves:

A página também mostra as seguintes informações para cada chave:

• Name (Nome): o nome da chave e seus últimos dígitos. As chaves com uma versão MCP exibem um rótulo MCP. 

  💡 É bom saber

  Se você vir um ícone de aviso ao lado de uma tag RSS, isso significa que a chave expirou.
• Permissões: 
  • Full access (Acesso total) significa que a chave pode acessar todos os recursos. 
  • Restricted (Restrita) seguida por um número de escopos significa que a chave só pode acessar esse número de recursos. Passe o mouse sobre as permissões para ver quais recursos a chave inclui.
• Status: se a chave está ativa ou desativada.
• Expires on (Expira em): a data em que a chave expira, ou No fixed date (Sem data definida) se você não definiu uma data de expiração.
• Last used on (Último uso em): a data da última chamada API feita com a chave.

Editar uma chave API

Se uma integração precisar de mais ou menos acesso do que o concedido a ela inicialmente, você poderá alterar o acesso de sua chave API a qualquer momento. Você também pode editar o nome e a data de validade da 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. Ao lado da chave API que você quer editar, clique no ícone de três pontos e selecione Edit API key (Editar chave API).
   
3. Digite o código de verificação enviado para o seu dispositivo e clique em Verify (Verificar). Para saber mais, consulte nosso artigo dedicado Verificar sua identidade para ações confidenciais na Brevo. 

4. Faça as alterações necessárias. 

   ❗️ Importante

   Se você remover uma permissão da qual uma integração ainda precisa, suas chamadas API falharão com um erro de Acesso negado ao recurso. Para saber mais, confira nosso artigo dedicado Solução de problemas – Problemas com chaves API
5. Clique em Save changes (Salvar alterações). 

Você atualizou sua chave API com sucesso.

Desativar ou reativar uma chave API

Se você deseja pausar temporariamente o uso de uma chave API em vez de excluí-la completamente, desative-a e reative-a mais tarde quando precisar dela novamente. Você também pode reativar uma chave que foi desativada.

1. Clique no menu suspenso da sua conta e selecione Settings (Configurações) > SMTP e API > API Keys & MCP (Chave API e MCP).
2. Ao lado da chave API que você deseja desativar ou reativar, clique no ícone de três pontos e selecione Deactivate API key (Desativar chave API) ou Activate API key (Ativar chave API).
   

Agora você desativou ou reativou sua chave API com sucesso.

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ê poderá 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. Ao lado da chave API que você quer excluir, clique no ícone de três pontos e selecione Delete API key (Excluir chave API).
   

Você excluiu sua chave API com sucesso.

Práticas recomendadas com chaves API

Proteja todas as chaves API da mesma forma que uma senha. Aqui estão algumas práticas recomendadas para ter em mente:

• Use uma chave API diferente para cada integração e inclua o nome da integração no nome da chave. Dessa forma, se uma chave for comprometida, você poderá excluí-la sem afetar suas outras integrações.
• Use acesso restrito e conceda a cada chave apenas as permissões de que ela precisa. Dessa forma, uma chave comprometida só pode acessar os recursos que você selecionou.
• 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. Oculte sua chave API ou, melhor ainda, corte-a completamente em capturas de tela 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.
• 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.

⏭️ O que vem a seguir?

• Sobre as permissões de chave API 
• Solução de problemas – Problemas com chaves API
• Criar e gerenciar suas chaves SMTP
• 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.