Versão 1.0 · Maio 2026

API DirectLuz

Documentação oficial da API pública DirectLuz. Integre sistemas externos ao módulo de Ordens de Serviço via Webhook ou Polling — em qualquer ambiente, sobre HTTPS com chave de API.

Módulos disponíveis

A v1 da API pública cobre o módulo de Ordens de Serviço. Novos módulos serão acrescentados de forma aditiva.

Ordens de Serviço

Criar solicitações, receber atualizações de status e fechamento. Inclui Inbound API, Outbound Webhook e modo Polling.

Ver módulo

Em breve

Novos módulos públicos serão acrescentados conforme expostos: alertas, dispositivos IoT e outros.

Princípios da API

Autenticação por chave de API

Chave rotativa no cabeçalho X-Api-Key. HTTPS/TLS 1.2+ obrigatório em ambos os sentidos.

Webhook ou Polling

Dois modos equivalentes. Escolha o que melhor encaixa na sua infraestrutura.

Contratos estáveis

Idempotência por chave, payloads versionados, retentativa com backoff. Sem surpresas em produção.