Pular para o conteúdo principal

LightHouse API

Novo por aqui?

Comece com IA → — use ChatGPT, Claude ou similar para gerar suas integrações a partir desta documentação, sem precisar programar do zero.

A LightHouse API é o backend do Leankeep, plataforma SaaS de gestão de manutenção predial. Ela expõe, via HTTP/JSON, os fluxos de:

  • Manutenção preventiva — planos de atividades periódicas sobre ativos (atividades).
  • Manutenção corretiva — registro e resolução de problemas (ocorrências).
  • Cadastro de ativos — hierarquia Empresa → Unidade → Área → Equipamento.
  • Usuários, permissões, relatórios e sincronização com o app mobile.

Como esta documentação está organizada

SeçãoPara quê
GuiasEntender os conceitos e percorrer fluxos completos passo a passo. Comece aqui.
Referência de APIDetalhe de cada endpoint: rota, parâmetros, corpo, respostas e exemplos em cURL, C#, Node.js e Python.

Primeiros passos

  1. Leia Primeiros passos para fazer sua primeira chamada autenticada.
  2. Entenda o fluxo de autenticação (JWT via AuthCenter).
  3. Familiarize-se com os conceitos de domínio antes de integrar.

Convenções

  • Base URL (produção): https://lighthousev2.lkp.app.br
  • Versionamento: o caminho carrega a versão — /v1/..., /v2/..., /v3/.... Ver Versionamento.
  • Formato: JSON em requisições e respostas.
  • Autenticação: Authorization: Bearer <token> em toda chamada (salvo endpoints públicos explícitos).
Status

Esta documentação está em construção ativa. A Referência de API foi gerada a partir do código-fonte; os schemas de payload (*Command, Filtro*) estão sendo enriquecidos a partir dos DTOs reais.