As API Keys permitem que você se autentique na API do Databases a partir de aplicações externas, scripts ou integrações. Cada chave pode ter permissões granulares e uma data de expiração configurável.
Criando uma API Key
Vá para as configurações
Navegue até Configurações > API Keys na barra lateral esquerda.
Clique em + Criar API key
O botão está localizado no canto superior direito.
Configure a chave
Preencha os seguintes campos:
- Nome — Um nome descritivo para identificar a chave (ex.: “CI Bot”, “Backend Produção”)
- Permissões — Selecione as permissões que a chave precisa
- Expiração — Por quanto tempo a chave deve permanecer válida
Clique em Criar
A chave é gerada e exibida apenas uma vez. Copie-a e guarde-a em um lugar seguro.
A chave completa é exibida apenas uma vez no momento da criação. Se você perdê-la, precisará regenerar a chave ou criar uma nova.
Permissões disponíveis
As permissões são divididas em duas categorias:
Registros
| Permissão | Descrição |
|---|
| Ler registros | Permite ler e pesquisar registros nas coleções |
| Criar e atualizar registros | Permite criar novos registros e atualizar os existentes |
| Excluir registros | Permite excluir registros |
| Permissão | Descrição |
|---|
| Ler arquivos | Permite baixar anexos de arquivos |
| Fazer upload de arquivos | Permite fazer upload de arquivos para registros |
Aplique o princípio do menor privilégio: conceda apenas as permissões que a aplicação realmente precisa. Por exemplo, um painel somente leitura requer apenas Ler registros.
Opções de expiração
| Opção | Descrição |
|---|
| 7 dias | A chave expira em 7 dias |
| 30 dias | A chave expira em 30 dias (padrão) |
| 60 dias | A chave expira em 60 dias |
| 90 dias | A chave expira em 90 dias |
| 180 dias | A chave expira em 180 dias |
| Sem expiração | A chave nunca expira |
Chaves sem expiração não são revogadas automaticamente. Use-as apenas quando estritamente necessário e combine com permissões mínimas.
Gerenciando API Keys
A tabela de API Keys mostra todas as chaves criadas com as seguintes informações:
- Nome — Nome da chave
- Permissões — Permissões atribuídas
- Chave — Os últimos caracteres da chave (mascarada)
- Criado — Data de criação
- Expira — Data de expiração
Ações disponíveis
- Regenerar — Gera uma nova chave mantendo o mesmo nome e permissões. A chave anterior para de funcionar imediatamente.
- Excluir — Exclui permanentemente a chave. Qualquer aplicação que a utilize perderá o acesso imediatamente.
Usando a API Key
Inclua a chave no cabeçalho X-Api-Key das suas requisições HTTP:
curl -s -X GET 'https://your-instance.jelou.cloud/api/collections/your_collection/records' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'Accept: application/json'
