Neste artigo, vamos explicar o que é uma chave API e como criar uma nova ou excluir uma existente.

É bom saber

Apenas usuários Brevo com permissões 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ários e níveis de permissões, consulte nosso artigo dedicado Permissões de usuário e níveis de permissão na Brevo.

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 (Chave API e MCP).
2. Clique em Generate new API key (Gerar nova chave API).
   
3. 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.
4. Clique em Generate (Gerar).
   
5. 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.
   
6. 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 de API do servidor MCP), a chave de API criada no passo 4 será desativada e, em vez disso, será gerada uma versão MCP da chave de API.
7. Clique em OK.

Você criou uma nova 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ê 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

As chaves API dão acesso completo a sua conta Brevo e devem ser protegidas da mesma maneira que uma senha. Veja algumas práticas recomendadas para 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.

🤔 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.