> ## Documentation Index
> Fetch the complete documentation index at: https://agile-docs.3code.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# API Keys

> Gerencie as chaves de API para acesso seguro aos seus serviços.

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

<img className="block dark:hidden rounded-lg" src="https://mintcdn.com/3code/o-pbI1OBAQbrtTbf/public/images/organization/api-keys/api-keys-light.png?fit=max&auto=format&n=o-pbI1OBAQbrtTbf&q=85&s=838771263684546cca606195229801f0" alt="API Keys Light" width="1920" height="1080" data-path="public/images/organization/api-keys/api-keys-light.png" />

<img className="hidden dark:block rounded-lg" src="https://mintcdn.com/3code/o-pbI1OBAQbrtTbf/public/images/organization/api-keys/api-keys-dark.png?fit=max&auto=format&n=o-pbI1OBAQbrtTbf&q=85&s=ee40a3bc0268503b03c117c9ffd2ae30" alt="API Keys Dark" width="1920" height="1080" data-path="public/images/organization/api-keys/api-keys-dark.png" />

***

## 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](/general/create)**".
* **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:

### Formulário de Cadastro

<Card>
  <div>
    <img className="block dark:hidden rounded-lg" src="https://mintcdn.com/3code/o-pbI1OBAQbrtTbf/public/images/organization/api-keys/api-keys-create-light.png?fit=max&auto=format&n=o-pbI1OBAQbrtTbf&q=85&s=47eeba09c65bb97447469dbee2a016e4" alt="Configurações de aparência - tema claro" width="1920" height="1080" data-path="public/images/organization/api-keys/api-keys-create-light.png" />

    <img className="hidden dark:block rounded-lg" src="https://mintcdn.com/3code/o-pbI1OBAQbrtTbf/public/images/organization/api-keys/api-keys-create-dark.png?fit=max&auto=format&n=o-pbI1OBAQbrtTbf&q=85&s=86f19b2a8f6963528b8bfa5f4b8e41d3" alt="Configurações de aparência - tema escuro" width="1920" height="1080" data-path="public/images/organization/api-keys/api-keys-create-dark.png" />
  </div>

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

O formulário de criação inclui os campos:

* **Nome / Proprietário**: identificação da chave.
* **Descrição**: finalidade da chave (opcional), para facilitar o gerenciamento.
* **Escopos**: as permissões/áreas que a chave poderá acessar — selecione um ou mais.
* **Usuário associado**: vincula a chave a um usuário; as requisições assumem o contexto desse usuário.
* **Validade**: data de expiração (ou sem expiração).
* **Ativa?**: habilita ou desabilita a chave.

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

<Info>
  Apenas usuários com permissões administrativas ou acesso à seção de
  configurações podem visualizar e gerenciar as API Keys.
</Info>