Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.jelou.ai/llms.txt

Use this file to discover all available pages before exploring further.

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.
Tabela de API Keys mostrando chaves criadas com colunas Nome, Permissões, Chave, Criado, Expira e botões Regenerar e Excluir

​
Criando uma API Key

1

Vá para as configurações

Navegue até Configurações > API Keys na barra lateral esquerda.
2

Clique em + Criar API key

O botão está localizado no canto superior direito.
3

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
4

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ãoDescrição
Ler registrosPermite ler e pesquisar registros nas coleções
Criar e atualizar registrosPermite criar novos registros e atualizar os existentes
Excluir registrosPermite excluir registros
Arquivos
PermissãoDescrição
Ler arquivosPermite baixar anexos de arquivos
Fazer upload de arquivosPermite 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çãoDescrição
7 diasA chave expira em 7 dias
30 diasA chave expira em 30 dias (padrão)
60 diasA chave expira em 60 dias
90 diasA chave expira em 90 dias
180 diasA chave expira em 180 dias
Sem expiraçãoA 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'