Skip to main content
A API pública é autenticada exclusivamente por chave de API, enviada no cabeçalho HTTP padrão Authorization, usando o esquema Bearer:
O formato da chave é nll_{ambiente}_{key_id}_{secret}:

​
Só Authorization: Bearer

A chave precisa ser enviada no cabeçalho Authorization: Bearer <chave>. A API rejeita ativamente qualquer tentativa de enviá-la por outro canal — mesmo que a chave seja válida:
  • Query string (?api_key=... ou ?apikey=...)
  • Cookie (api_key/apikey)
  • Cabeçalhos alternativos (X-API-Key, X-Api-Key, Api-Key)
Qualquer uma dessas tentativas retorna 401 Unauthorized.

​
Erros de autenticação

​
Escopos

Cada chave de API tem um conjunto de escopos que determina quais endpoints ela pode chamar (ex.: entities:read, analyses:create, webhooks:write). O escopo exigido por cada endpoint está documentado na seção “Conceitos” correspondente e na referência OpenAPI.

​
Como obter uma chave

Chaves de API são provisionadas pelo time NL Labs através do painel administrativo da plataforma — não há um fluxo de autoatendimento (self-service) para criar uma chave diretamente pela API. Entre em contato com o time NL Labs para solicitar uma.