Pular para o conteúdo principal

Primeiros passos

Este guia leva você da credencial à primeira resposta da API.

Pré-requisitos​

  • Credenciais de acesso ao AuthCenter (provedor de identidade do Leankeep).
  • A base URL do ambiente que vai consumir (produção ou homologação).
  • Um cliente HTTP (cURL, Postman, ou SDK na sua linguagem).

Obtendo credenciais​

Para autenticar, você precisa de um usuário e senha do Leankeep válidos no ambiente que for usar.

  • Produção: use seu usuário e senha normais do Leankeep.
  • Sandbox: o acesso ao ambiente sandbox (lighthouse.lkp.dev.br) é solicitado ao administrador Leankeep da sua empresa. Se você é o administrador, solicite as credenciais de sandbox ao suporte Leankeep.
  • Usuário dedicado de integração (recomendado para automações/IA, ver Boas práticas de segurança): a criação é feita pelo administrador da empresa, que solicita ao suporte Leankeep um usuário específico para esse fim. Recomendações: perfil Operacional ou Chamado (nunca Administrador), escopo restrito às Unidades necessárias, e nome identificável (ex.: integracao.ia) para facilitar auditoria.

1. Obtenha um token JWT​

Toda chamada à LightHouse API exige um JWT Bearer emitido pelo AuthCenter. Veja o detalhamento completo (resposta, refresh, ambientes) em Autenticação.

curl --location 'https://auth.lkp.app.br/v1/auth/' \
  --form 'login=SEU_USUARIO' \
  --form 'Password=SUA_SENHA' \
  --form 'Plataform=6' \
  --form 'ExpireCurrentSession=True' \
  --form 'StayConnected=True'

Campos do form-data: login, Password, Plataform=6, ExpireCurrentSession=True, StayConnected=True.

Sessão ativa bloqueia novo login (validado 07/2026)

Se o mesmo login já tem uma sessão ativa (app, outra aba, outro teste), envie ExpireCurrentSession=True no POST /v1/auth/ para derrubar a sessão anterior e receber um token utilizável. Atenção: isso expulsa a sessão ativa daquele usuário. Para automações/integrações, use um login dedicado (ver Obtendo credenciais acima).

A resposta é um JSON com o JWT em authToken.token — esse é o valor que você usa no header Authorization (não o topo da resposta). Ver a estrutura completa em Autenticação → Resposta.

2. Faça uma chamada autenticada​

Com o token em mãos, teste um endpoint simples — por exemplo, as empresas que seu usuário acessa:

curl "https://lighthousev2.lkp.app.br/v1/empresas/ativas" \
  -H "Authorization: Bearer SEU_TOKEN"
EmpresaId no header nos endpoints de discovery (validado 07/2026)

Nos endpoints de descoberta de IDs (unidades/ativas, sistemas, areas, equipamentos, usuarios), EmpresaId é um header HTTP (-H "EmpresaId: 4157"), não query string — mesmo quando a referência do endpoint mostra empresaId como parâmetro. Colocar na query pode gerar [] + HTTP 200 silencioso (ex.: GET /v1/sistemas), levando a concluir erradamente que a empresa não tem dados.

Descobrindo seu EmpresaId​

Toda chamada precisa do header EmpresaId. Para descobrir quais empresas seu token acessa:

curl "https://lighthousev2.lkp.app.br/v1/empresas/ativas" \
  -H "Authorization: Bearer SEU_TOKEN"

Retorna a lista com empresa (o ID), nome, tipo e flags de módulo. Escolha o ID desejado e use-o no header EmpresaId das demais chamadas.

Paginação de ocorrências

GET /v3/ocorrencias exige PageSize (1–100) além de PageIndex. Sem PageSize: 400 "PageSize precisa ser entre 1 a 100." Ver Paginação e filtros para o mecanismo completo.

3. Explore a referência​

A partir daqui, use a Referência de API para descobrir os endpoints de cada recurso. Cada operação traz exemplos prontos em cURL, C#, Node.js e Python.

PowerShell: corpo JSON em POST/PUT​

Os exemplos cURL desta documentação usam -d '{...}' com JSON multilinha entre aspas simples — sintaxe de bash/POSIX. Testado: não funciona no PowerShell 5.1 (o parser de aspas do PowerShell não preserva o corpo da mesma forma; o JSON chega vazio ou corrompido ao curl.exe).

Padrão que funciona no PowerShell: salve o corpo em um arquivo e referencie-o com -d "@caminho":

@'
{
  "empresaId": 123,
  "siteId": 456,
  "plataforma": 6
}
'@ | Out-File -Encoding utf8 body.json

curl.exe -X POST "https://lighthousev2.lkp.app.br/v3/ocorrencias" `
  -H "Authorization: Bearer SEU_TOKEN" `
  -H "Content-Type: application/json" `
  -d "@body.json"

Duas pegadinhas comuns:

  • Use curl.exe explicitamente — curl sozinho no PowerShell 5.1 é um alias para Invoke-WebRequest, que não aceita os mesmos parâmetros.
  • O heredoc precisa ser @'...'@ (aspas simples, literal) para não expandir $ do JSON; o '@ de fechamento tem que estar sozinho na coluna 0.

Esse padrão vale para qualquer exemplo -d '{...}' desta documentação — troque o conteúdo do heredoc pelo corpo do endpoint que estiver usando.

Próximos passos​