Pular para o conteúdo principal
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 Name, Permissions, Key, Created, Expires e botões Regenerate e Delete

Lista de API Keys com nome, permissões, chave mascarada e ações

Criando uma API Key

1

Acesse as configurações

Vá para Configurações > API Keys na barra lateral esquerda.
2

Clique em + Create API key

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

Configure a chave

Preencha os seguintes campos:
  • Name — Um nome descritivo para identificar a chave (ex.: “CI Bot”, “Backend Produção”)
  • Permissions — Selecione as permissões que a chave precisa
  • Expiration — Por quanto tempo a chave deve permanecer válida
4

Clique em Create

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: Records (Registros) Files (Arquivos)
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 Read records.

Opções de expiração

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:
  • Name — Nome da chave
  • Permissions — Permissões atribuídas
  • Key — Os últimos caracteres da chave (mascarada)
  • Created — Data de criação
  • Expires — Data de expiração

Ações disponíveis

  • Regenerate — Gera uma nova chave mantendo o mesmo nome, as mesmas permissões e a data de expiração original (o período não é reiniciado). A chave anterior para de funcionar imediatamente.
  • Delete — 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: