Chaves de API

Crie chaves de API para acesso programático ao Entity Enricher. Utilize chaves de acesso de organização para integração serviço-a-serviço, pipelines de CI/CD e fluxos de trabalho automatizados.

Tipos de chave

O Entity Enricher suporta dois tipos de chaves de API, cada um adequado a diferentes casos de uso:

Recomendado

Chaves de Acesso da Organization

Chaves autónomas com a sua própria função, não associadas a nenhuma conta de utilizador. A melhor escolha para integração serviço-a-serviço.

  • Têm a sua própria função (proprietário, editor ou operador)
  • Não afetado por alterações à conta de utilizador
  • Limitado à organização
  • Exigir função de proprietário para criar

Chaves de utilizador legadas

Chaves associadas a uma conta de utilizador específica. Herdam a função do criador e são afetadas por alterações à conta de utilizador.

  • Herdar a função do utilizador criador
  • Se o utilizador for desativado, a chave deixa de funcionar
  • Qualquer utilizador autenticado pode criar um

Formato e segurança da chave

Formato:ent_a1b2c3d4e5f6g7h8

As chaves usam o prefixo ent_ seguido de bytes aleatórios. A chave completa é mostrada apenas uma vez no momento da criação — não pode ser recuperada mais tarde.

As chaves de acesso (para chamar a API do Entity Enricher) são armazenadas como hashes SHA256 na base de dados, por isso, mesmo com acesso à base de dados, não é possível recuperar a chave original. Apenas os primeiros 12 caracteres (o prefixo) são armazenados em texto simples para identificação.

Chaves de fornecedor (chaves de API de LLM como Anthropic, OpenAI) são encriptadas em repouso através da encriptação simétrica Fernet (AES-128-CBC + HMAC). Têm de ser desencriptáveis em tempo de execução para autenticar junto dos fornecedores de LLM. Apenas os últimos 4 caracteres são armazenados em texto simples.

  1. 1Uma chamada curl pronta a usar, com a chave já no cabeçalho
O corpo da chave foi propositadamente ocultado nesta captura de ecrã. A base de dados guarda apenas o prefixo ent_ e um hash, pelo que uma chave que não tenha sido copiada aqui é substituída, nunca recuperada.

A criar chaves de API

Crie chaves a partir da página de chaves de API na aplicação ou programaticamente através da API REST:

Configuração da chave

CampoDescrição
NomeUm nome descritivo para identificação (por exemplo, "CI/CD Pipeline", "Integração n8n")
FunçãoO nível de permissão: owner, editor ou operator. Determina a que a chave pode aceder.
Âmbitosleitura, escrita ou ambas. Controla se a chave pode modificar dados ou apenas lê-los.
ExpiraçãoData de expiração opcional. As chaves sem expiração permanecem válidas até serem revogadas.
  1. 1O papel da própria chave — que nunca pode ser superior ao seu
  2. 2Sem expiração significa válida até alguém a revogar
Os âmbitos são o único campo que o formulário omite: uma chave criada aqui tem leitura e escrita, e uma chave só de leitura é pedida através da API.

Utilizar chaves de API

Envie a sua chave de API no cabeçalho X-API-Key em cada pedido:

curl -H "X-API-Key: ent_your_key_here" \
     https://your-instance.example.com/api/enrichment/options

Métodos de Autenticação

MétodoCabeçalhoCaso de utilização
Chave de APIX-API-Key: ent_...Serviço a serviço, CI/CD, automação
Bearer TokenAuthorization: Bearer <jwt>Clientes web, sessões interativas
OAuth 2.1Authorization: Bearer <access_token>Conectores e clientes de IA — uma autorização revogável por aplicação, não uma chave partilhada

Acesso a Endpoints por Função

O papel da chave de API determina os endpoints a que pode aceder:

Categoria de endpointFunção mínima
Enriquecimento (único, lote)Operador
Registos (listar, detalhe, eliminar)Operador
Esquema (ler)Operador
Esquema (criar, editar, eliminar)Editor
FusãoOperador
Informações do fornecedorOperador
Análise de custosOperador
Gestão de chaves de APIProprietário
Gestão de utilizadoresProprietário

Gestão de Chaves

A página de Chaves de API fornece uma visão completa de todas as chaves da organização com estatísticas de utilização:

Ver utilizaçãoVeja o registo de data/hora da última utilização e o número total de utilizações de cada chave
Atualizar funçãoAlterar a função de uma chave de acesso da organização (apenas proprietário)
RevogarDesativar permanentemente uma chave. As chaves revogadas não podem ser reativadas.
ExpiraçãoAs chaves que expiram dentro de 7 dias são sinalizadas. As chaves expiradas são rejeitadas automaticamente.
  1. 1A função muda no local, sem reemitir a chave
  2. 2A revogação tem efeito imediato e não pode ser anulada
A coluna Chave mostra um prefixo porque é só isso que fica guardado: o suficiente para distinguir duas chaves na tabela e num registo de auditoria, inútil para quem tente chamar a API com ele.

Chaves de Fornecedor vs. Chaves de Acesso

A página Chaves de API tem cinco separadores com finalidades distintas — quatro para todos, mais Chaves globais para administradores de sistema:

  1. 1As chaves dos fornecedores de LLM da sua organização
  2. 2O pool partilhado de reserva — apenas administradores de sistema
  3. 3Chaves que chamam a própria API do Entity Enricher
Os dois primeiros separadores contêm chaves que o Entity Enricher usa para chegar a um LLM; os três últimos contêm credenciais que outros sistemas usam para chegar à sua organização. A página nunca o diz, mas é essa direção que determina a que separador pertence cada chave.

Chaves de fornecedores de IA

As chaves de API dos fornecedores de LLM da sua organização (Anthropic, OpenAI, etc.) para faturação independente. Suporta várias chaves por fornecedor com rotação LRU automática; uma chave cujo teste falhe sai da rotação até ser novamente testada ou substituída. Consulte Modelos e Preços para conhecer o sistema BYOK.

As chaves de fornecedor são encriptadas em repouso através de encriptação simétrica Fernet (AES-128-CBC com autenticação HMAC). Só são desencriptadas em tempo de execução ao efetuar chamadas à API de LLM. Apenas os últimos 4 caracteres são armazenados em texto simples para efeitos de apresentação.

Chaves globais

Chaves de fornecedores de LLM à escala do sistema, geridas pelos administradores. Utilizadas como alternativa quando não existe nenhuma chave da organização. Suporta várias chaves por fornecedor com rotação LRU: a próxima é a chave ativa utilizada há mais tempo, e uma chave sai da rotação quando um administrador a desativa ou o respetivo teste a marca como inválida. Se não houver nenhuma chave utilizável para um fornecedor, a execução é recusada em vez de iniciada.

Chaves de acesso à aplicação

Chaves de acesso da organização para a API do próprio Entity Enricher. Utilizadas por sistemas externos para chamar programaticamente os endpoints de enriquecimento, esquema, registos e outros. Consulte a Referência da API para a documentação dos endpoints.

Aplicações Ligadas

Aplicações que autorizou através de OAuth 2.1 — o diretório de conectores do claude.ai, o Claude Desktop e as ligações Make e n8n. Cada linha é uma autorização revogável e não um segredo partilhado: revogá-la aqui invalida os tokens dessa aplicação sem afetar as restantes integrações. Os proprietários podem ainda registar um cliente OAuth para uma instância n8n self-hosted.

Túneis Ollama

Credenciais do túnel Ollama self-service, que expõe uma instância local do Ollama à plataforma sem abrir portas. Consulte o guia Ollama Tunnel.

  1. 1Quem o autorizou — a concessão herda a função desse membro
  2. 2Que superfície o token pode usar: a API REST, MCP ou ambas
  3. 3Revogar uma aplicação mantém todas as outras ligações com sessão iniciada
O separador Aplicações ligadas: uma linha por aplicação autorizada e por membro, para que a mesma pessoa possa ligar o claude.ai e uma instância n8n em separado. É a coluna Última utilização que lhe diz qual o conector ainda em funcionamento antes de o revogar.

Próximos Passos