Pesquisa

Crie e gerencie suas chaves API

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:

API_keys.jpg

É 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

💡 É bom saber
Whenever an API key is created or deleted from the account, the account owner will receive an email notification, including details such as the IP address and location.

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

  1. Click your account dropdown and select Settings > SMTP & API > API Keys & MCP.
  2. Click Generate a new API key.
    create_new_key.jpg
  3. Name your API key. Make sure it specifies with which integration the API key will be used so that you can easily recognize it.
  4. Click Generate.
    name_key.jpg
  5. Copie sua chave API e a armazene em um ambiente seguro.
    ❗️ Importante
    Your API key is only visible during this step. Once your API key is created, you won't be able to copy it anymore and you'll need to create a new one if you lose it.
    plugins_copy-api-key_en-us.png
  6. (Optional) Activate the Create MCP server API key option to generate a version of the API key allowing you to connect an AI system to Brevo via the MCP protocol. To learn more, check our dedicated article What is Model Context Protocol (MCP)?.
    💡 É bom saber
    If you activate the Create MCP server API key, the API key created in step 4 is deactivated and a MCP version of the API key is generated instead.
  7. 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).
    API_deactivate-key_en-us.png

Agora você reativou sua chave API.

To reactivate a key, select it again and click Activate API key.

Exclusão de uma chave API

❗️ Importante
Deleting an API key is irreversible. Before deleting an API key, make sure you no longer use the integration that requires it or that you've replaced it with a new API key. If you delete an API key that is still being used, you'll experience integration failures.

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).delete_key.jpg

Você excluiu sua chave API com sucesso.

Práticas recomendadas com chaves API

❗️ Importante

Para melhorar a segurança e reduzir o risco de exposição de credenciais não utilizadas, chaves API inativas expiram após 90 dias. 

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.

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

💬 Este artigo foi útil?

127 de 191 acharam isto útil