Chaves de API

O que são Chaves de API?

Uma chave de API na Imara é um conjunto de credenciais — um Client ID e um Client Secret — que permite que uma aplicação ou script externo se autentique na API da Imara em nome da sua organização. Pense nisso como uma senha especial criada exclusivamente para automação, não para login humano.

Como criar uma chave de API

1. Acesse Configurações → Chaves de API no painel do cliente.
2. Clique em Criar Chave de API.
3. Dê um nome descritivo à chave — por exemplo, "Pipeline CI/CD" ou "Dashboard de Segurança Interno".
4. Selecione os escopos (permissões) que essa chave precisa. Conceda apenas o que for necessário para a tarefa.
5. Clique em Criar. O Client ID e o Client Secret serão exibidos uma única vez — copie-os imediatamente para um local seguro.

Importante: O Client Secret não é armazenado pela Imara e não pode ser recuperado depois. Se você perdê-lo, precisará revogar a chave e criar uma nova.

Limites por plano

O número de chaves de API ativas que você pode ter ao mesmo tempo depende do seu plano de assinatura:

• Free — acesso à API não está disponível
• Starter — acesso à API disponível
• Professional — até 5 chaves de API ativas
• Enterprise — até 20 chaves de API ativas
  
  

Como a Imara conta as chaves de API

Apenas chaves ativas (não revogadas) contam para o limite do plano. Ao revogar uma chave, ela é imediatamente desativada e não conta mais, liberando uma vaga para uma nova.

Precisa de mais chaves?

• Faça upgrade do plano — migre do Professional para o Enterprise para aumentar o limite para 20.
• Entre em contato com o suporte — escreva para [email protected] para discutir limites personalizados.
  
  

Revogando uma chave de API

1. Acesse Configurações → Chaves de API.
2. Encontre a chave que deseja remover e clique em Revogar.
3. Confirme a ação. A chave é desativada imediatamente.

Revogue chaves sempre que não forem mais necessárias, quando um membro que as gerenciava sair da equipe, ou se suspeitar que uma chave pode ter sido comprometida.

Dicas de segurança

• Trate o Client Secret como uma senha — nunca o compartilhe por chat ou e-mail
• Armazene os secrets em um gerenciador de segredos (ex: AWS Secrets Manager, 1Password) — nunca em arquivos de texto ou controle de versão
• Crie uma chave por caso de uso para poder revogar chaves individuais sem afetar outras integrações
• Conceda apenas os escopos mínimos necessários para cada chave