Visão geral
Documentação oficial de integração de sistemas externos com a plataforma DirectLuz.
Este site é a documentação oficial de integração entre sistemas externos e a plataforma DirectLuz.
A API cobre criação de Ordens de Serviço (solicitações, eventos de ciclo de vida e fechamento) e leitura em lote de postes, telegestores e ordens de serviço do tenant do parceiro. Novos módulos serão adicionados aqui à medida que forem expostos publicamente, sempre de forma aditiva e retrocompatível.
Como a documentação é organizada
- Autenticação — como autenticar suas chamadas à API e como verificar webhooks recebidos.
- Convenções — encoding, formatos de data, idempotência e limites aplicados em toda a API.
- Ambientes — sandbox e produção.
- APIs disponíveis — Ordens de Serviço e Leitura de Dados da Cidade.
O que esta API permite
- Registrar solicitações operacionais no DirectLuz a partir do sistema externo.
- Receber notificações de cada alteração no ciclo de vida das Ordens de Serviço — em tempo real (Webhook) ou via consulta periódica (Polling).
- Manter correlação entre o protocolo do sistema externo e o protocolo interno da DirectLuz.
- Ler em lote, com pull incremental por data, os postes/telegestores e as ordens de serviço do tenant (escopo
canReadCityData).
O que NÃO faz parte desta API
- Cadastro/edição de postes, estoque, dispositivos IoT, equipes — esses domínios permanecem internos (a API só expõe leitura).
- Operações de relatórios e analytics.
- Qualquer endpoint não listado neste site.