Referência
Glossário
Termos usados em toda a documentação da API DirectLuz.
| Termo | Definição |
|---|---|
| API | Application Programming Interface — interface de programação que expõe operações da DirectLuz a sistemas externos |
Ativo (assetType) | Bem físico sobre o qual a Ordem de Serviço atua. Campo obrigatório. Enum extensível. Valor aceito nesta versão: POLE |
| Backoff exponencial | Estratégia de retentativa em que o intervalo entre tentativas dobra a cada falha, até um teto definido |
| DLQ | Dead Letter Queue — fila interna que retém eventos cuja entrega falhou após o limite de tentativas |
| HMAC | Hash-based Message Authentication Code — assinatura criptográfica que garante autenticidade e integridade da mensagem |
| HTTPS | HyperText Transfer Protocol Secure — protocolo HTTP encapsulado em TLS |
| Idempotência | Propriedade pela qual a repetição de uma mesma operação produz o mesmo resultado, sem duplicar efeitos |
| JSON | JavaScript Object Notation — formato de serialização adotado em toda a API |
| OS | Ordem de Serviço — unidade operacional gerada e gerenciada pela DirectLuz |
| Polling | Modo de operação em que a DirectLuz consulta o endpoint do parceiro (e expõe seu próprio) em janelas recorrentes de até 3 minutos |
| Protocolo externo | Identificador único da solicitação no sistema externo (protocolNumber) |
| Protocolo interno | Identificador da Ordem de Serviço na DirectLuz (internalProtocol, ex.: OS-00042), acompanhado do id UUID como chave técnica |
| Tenant | Inquilino no modelo multi-tenant — corresponde a um município ou contrato |
| TLS | Transport Layer Security — protocolo de cifragem do tráfego HTTPS. Versão mínima exigida: 1.2 |
| UUID | Universally Unique Identifier — identificador de 128 bits empregado para chaves técnicas |
| Webhook | Modo de operação em que a DirectLuz envia notificação HTTP POST ao receptor a cada ocorrência de evento |