Skip to main content
As APIs da NL Labs são autenticadas por chave de API, enviada no cabeçalho X-API-Key:
O formato da chave é nll_{ambiente}_{key_id}_{secret}:

Cabeçalho da chave

Envie a chave sempre no cabeçalho X-API-Key: <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)
Qualquer uma dessas tentativas retorna 401 Unauthorized.

Erros de autenticação

O corpo do erro depende da API chamada. Veja Erros.

Escopos

Cada chave de API tem um conjunto de escopos que determina quais endpoints ela pode chamar (ex.: entities:read, analyses:create, webhooks:write). Na API de Dados, os escopos são dados:consultar, dados:processos e um por dataset (dados:pep, dados:midia, …). O escopo exigido por cada endpoint está documentado nos guias e na referência de cada API.

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.