Ir para o conteúdo

APIs REST — Visão Geral

O servidor web do monitor (federated-rest-api, classe AdminWebServer, porta padrão 8088) expõe dois conjuntos distintos de rotas HTTP/JSON documentados em OpenAPI 3.1:

Especificação Público-alvo Escopo Documento
API Administrativa e Monitor Web Operadores, pesquisadores, UI web Gestão de contratos, deploy de pacotes .hdtpkg.zip/.hdtsim.zip, controle de rodadas, SSE em tempo real, containers Docker, explorador Fabric e métricas Referência Admin Monitor
API Client-Facing (Participantes HDT) Containers Docker e app Android Anúncio de presença, envio de consentimento LGPD, heartbeat CDDL/CDAL e download de pacotes DEX MDPL Referência Client-Facing

Separação entre plano administrativo (REST) e plano federado (MQTT)

O protocolo de treinamento federado (distribuição de RoundConfig, RoundFinalizationSignal, envio de ClientUpdateMessage e publicação de GlobalModelPublication) utiliza exclusivamente MQTT 5 com TLS/mTLS (PahoMqttGateway). As rotas REST existem apenas para administração, descoberta, consentimento, entrega de pacotes e monitoramento.

Arquivos OpenAPI