As permissões de chave API permitem que você controle exatamente o que cada chave API pode fazer em sua conta Brevo. Conceder a uma integração apenas o acesso necessário significa que uma chave comprometida ou compartilhada não pode ser usada para qualquer outra coisa.
É bom saber
- As chaves criadas antes de as permissões estarem disponíveis mantêm acesso total até que você as edite.
- As permissões aplicam-se apenas às chaves API. As chaves SMTP não são afetadas. Para saber mais, consulte nosso artigo dedicado Criar e gerenciar suas chaves SMTP.
Tipos de acesso
Ao criar ou editar uma chave API, você primeiro escolhe quanto da sua conta a chave pode alcançar:
- [Recomendado] Restricted (Restrita): você escolhe exatamente o que a chave pode alcançar. Cada recurso começa em None (Nenhum). Por isso, você só seleciona um nível de permissão para os recursos de que a chave precisa.
- Full (Total): a chave pode acessar todos os recursos atuais e futuros.
Níveis de permissão
Para cada recurso de uma chave Restricted (Restrita), você escolhe um de quatro níveis de permissão. A tabela a seguir mostra o que cada nível permite:
| Nível | O que a chave pode fazer | Solicitações de API permitidas |
|---|---|---|
| None (Nenhum) | Não tem acesso ao recurso. | None (Nenhum) |
| Read (Leitura) | Pode ver o recurso, mas não pode alterá-lo. | GET |
| Read/write (Leitura/gravação) | Pode ver, criar e atualizar o recurso, mas não pode excluí-lo. | GET, POST e PUT |
| All (Total) | Tem acesso total ao recurso, incluindo exclusão. | Todos os tipos de solicitação |
Recursos disponíveis
Você pode definir permissões em 18 recursos. Nem todos os recursos oferecem todos os níveis. A tabela a seguir mostra os níveis disponíveis para cada recurso:
| Recurso | Níveis disponíveis |
|---|---|
| E-mails transacionais | None (Nenhum), Read (Leitura) e All (Total) |
| SMS transacionais | None (Nenhuma), Read (Leitura), Read/write (Leitura/gravação) e All (Total) |
| WhatsApp transacional | None (Nenhuma), Read (Leitura), Read/write (Leitura/gravação) e All (Total) |
| Campanhas de e-mail | None (Nenhum), Read (Leitura) e All (Total) |
| Campanhas de SMS | None (Nenhum), Read (Leitura) e All (Total) |
| Campanhas do WhatsApp | None (Nenhum), Read (Leitura) e All (Total) |
| Contatos | None (Nenhum), Read (Leitura) e All (Total) |
| Oportunidades | None (Nenhum), Read (Leitura) e All (Total) |
| Conversas | None (Nenhuma), Read (Leitura), Read/write (Leitura/gravação) e All (Total) |
| E-commerce | None (Nenhuma), Read (Leitura), Read/write (Leitura/gravação) e All (Total) |
| Fidelização | None (Nenhuma), Read (Leitura), Read/write (Leitura/gravação) e All (Total) |
| Eventos | None (Nenhuma), Read (Leitura), Read/write (Leitura/gravação) e All (Total) |
| Objetos | None (Nenhum), Read (Leitura) e All (Total) |
| Conta | None (Nenhuma), Read (Leitura), Read/write (Leitura/gravação) e All (Total) |
| Webhooks | None (Nenhuma), Read (Leitura), Read/write (Leitura/gravação) e All (Total) |
| Organização | None (Nenhum), Read (Leitura) e All (Total) |
| Wallet | None (Nenhuma), Read (Leitura), Read/write (Leitura/gravação) e All (Total) |
| Funções Brevo | None (Nenhuma), Read (Leitura), Read/write (Leitura/gravação) e All (Total) |
Definir permissões em uma chave API
Para definir permissões em uma nova chave ou editar as permissões de uma chave existente, consulte nosso artigo dedicado Crie e gerencie suas chaves API.
O que acontece quando uma chave não tem a permissão necessária
Se uma integração fizer uma chamada não permitida por sua chave, a Brevo bloqueará a chamada e retornará um erro de Access denied for resource (Acesso negado ao recurso). Para corrigi-lo, verifique nosso artigo dedicado Solução de problemas – Problemas com chaves API.
⏭️ O que vem a seguir?
- Criar e gerenciar suas chaves API
- Solução de problemas – Problemas com chaves API
- Autorizar e bloquear endereços IP para segurança de API e SMTP
🤔 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.