Pular para o conteúdo principal

Visão geral

A seção de API Keys permite que você crie e gerencie chaves de acesso utilizadas para autenticação em integrações com sistemas externos de forma segura. Essas chaves são essenciais para garantir que apenas usuários autorizados possam consumir seus serviços. API Keys Light

Funcionalidades Disponíveis

  • Listagem de chaves: visualize todas as chaves criadas, seus status, data de criação, responsável e data de expiração.
  • Criação de nova chave: gere uma nova chave clicando no botão “Criar Novo”.
  • Cópia rápida da chave: utilize o ícone de cópia para transferir a chave para sua área de transferência com facilidade.
  • Status da chave: veja rapidamente se uma chave está ativa ou não.
  • Validade da chave: controle quando (ou se) uma chave irá expirar.
  • Propriedade e autoria: acompanhe quem criou cada chave e para qual propósito ela está sendo usada.

Estrutura da Chave

As chaves seguem um padrão que facilita sua identificação:
  • O prefixo da chave corresponde ao alias da organização (ex: AGILE-).
  • Esse padrão ajuda a rastrear a origem da chave em sistemas externos com múltiplas integrações.

Criação de uma Nova Chave

Para criar uma nova API Key, siga os passos abaixo:
1

Formulário de Cadastro

Configurações de aparência - tema claro

Após preencher os campos, clique em Confirmar. A chave será gerada automaticamente e exibida na listagem.

Recomendações de Uso

  • Utilize nomes descritivos no campo “Proprietário” para facilitar o gerenciamento.
  • Revogue chaves que não estejam mais em uso.
  • Evite expor as chaves publicamente. Caso isso ocorra, gere uma nova e desative a antiga imediatamente.
  • Prefira a configuração de validade sempre que possível para reduzir riscos de segurança.
Apenas usuários com permissões administrativas ou acesso à seção de configurações podem visualizar e gerenciar as API Keys.