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.
O Entity Enricher suporta dois tipos de chaves de API, cada um adequado a diferentes casos de uso:
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.
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.
ent_a1b2c3d4e5f6g7h8As 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.
Crie chaves a partir da página de chaves de API na aplicação ou programaticamente através da API REST:
| Campo | Descrição |
|---|---|
| Nome | Um nome descritivo para identificação (por exemplo, "CI/CD Pipeline", "Integração n8n") |
| Função | O nível de permissão: owner, editor ou operator. Determina a que a chave pode aceder. |
| Âmbitos | leitura, escrita ou ambas. Controla se a chave pode modificar dados ou apenas lê-los. |
| Expiração | Data de expiração opcional. As chaves sem expiração permanecem válidas até serem revogadas. |
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étodo | Cabeçalho | Caso de utilização |
|---|---|---|
| Chave de API | X-API-Key: ent_... | Serviço a serviço, CI/CD, automação |
| Bearer Token | Authorization: Bearer <jwt> | Clientes web, sessões interativas |
O papel da chave de API determina os endpoints a que pode aceder:
| Categoria de endpoint | Função mínima |
|---|---|
| Enriquecimento (único, lote) | Operador |
| Registos (listar, detalhe, eliminar) | Operador |
| Esquema (ler) | Operador |
| Esquema (criar, editar, eliminar) | Editor |
| Fusão | Operador |
| Informações do fornecedor | Operador |
| Análise de custos | Operador |
| Gestão de chaves de API | Proprietário |
| Gestão de utilizadores | Proprietário |
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:
A página de Chaves de API tem vários separadores com finalidades diferentes:
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. Consulte Modelos e Preços para 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 de fornecedores de LLM de todo o sistema geridas por administradores. Usadas como alternativa quando não há nenhuma chave de organização disponível. Suporta várias chaves por fornecedor com rotação LRU e desativação automática em falhas permanentes.
Chaves para aceder à própria API do Entity Enricher. Usadas 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.