Pular para o conteúdo principal

Chaves de API

As chaves de API permitem que outras ferramentas do seu time usem o RuleForge em seu nome — por exemplo, para validar regras a partir de um script interno ou acionar o RuleForge dentro de uma automação.

Quando criar uma chave

Crie uma chave quando quiser que uma ferramenta externa faça algo em nome da sua organização sem precisar abrir o navegador. Exemplos:

  • um script que valida regras antes de um deploy;
  • uma ferramenta interna que importa casos de teste;
  • uma automação que consulta o status de um projeto.

Para uso pessoal no navegador, você não precisa de chave — é só entrar normalmente.

Como criar uma chave

  1. Abra Configurações → Chaves de API.
  2. Clique em Nova chave.
  3. Escolha o que a chave pode fazer (os níveis de acesso são apresentados na tela).
  4. Defina um prazo de expiração, se a integração for temporária.
  5. Copie o valor da chave exibido na tela.

Importante: o valor completo da chave é mostrado uma única vez, no momento da criação. Guarde em um gestor de segredos imediatamente. Se você perder, só resta gerar uma nova.

Rotacionar e revogar

  • Rotacionar: gera um novo valor para a mesma chave sem quebrar a configuração existente. Use periodicamente como boa prática.
  • Revogar: encerra o acesso da chave imediatamente. Use quando a chave foi exposta, ou quando a integração não é mais necessária.

Todas as ações ficam registradas na auditoria da organização.

Boas práticas

  • Conceda apenas os acessos que a integração realmente precisa.
  • Use expiração sempre que puder.
  • Rotacione periodicamente.
  • Revogue chaves sem uso.
  • Não compartilhe a mesma chave entre sistemas diferentes — um vazamento isolado é mais fácil de conter.
  • Nunca coloque chaves em repositórios versionados ou em mensagens de chat.

Perguntas frequentes

Criei a chave mas não consigo mais ver o valor completo

Isso é esperado. O valor aparece só na criação. Gere uma nova chave e descarte a anterior.

Não vejo a opção de criar chaves de API

Pode ser uma limitação do seu plano. Consulte Cobrança e planos ou peça ao responsável pela organização para verificar.

Precisamos de mais de um nível de acesso

Crie chaves separadas, cada uma com o escopo mínimo necessário. Isso também facilita revogar uma sem afetar as outras.