Ir para o conteúdo

API Client-Facing — Participantes HDT (OpenAPI 3.1)

Versão da especificação: 1.0.0 · Endpoints: 8 · Operações: 8 · Schemas: 0

Baixar especificação OpenAPI YAML

Subconjunto da API do Monitor Web (AdminWebServer, porta 8088) chamado pelos proprios participantes HDT — containers Docker persistentes (DockerErgonomicClientDaemonApp e equivalentes) e o app cliente Android — nunca pelo dashboard/operador humano. Cobre anuncio de presenca, consentimento automatico (LGPD), heartbeat de status CDDL/CDAL, download do pacote DEX MDPL do experimento e callback legado de resultado de agregacao usado pelos daemons Docker ainda nao convertidos ao padrao "orquestrador manda tudo, agregador so responde" (ver BL-244/BL-250). A API de administracao/monitoramento (dashboard, operadores) esta documentada separadamente em openapi-admin-monitor.yaml.

Endpoints por Domínio

discovery

Anuncio de presenca e registro anonimo de instalacao

Método Caminho operationId Resumo
POST /api/experiments/{experimentId}/clients/{clientId}/announce announceClient Anuncia a presenca de um participante (bridge HTTP para o ClientDiscoveryService/MQTT)
POST /api/client-installations registerAnonymousInstallation Registra uma instalacao pelo UUID anonimo gerado localmente no aplicativo

Consentimento (LGPD) decidido pelo proprio participante

Método Caminho operationId Resumo
POST /api/experiments/{experimentId}/clients/{clientId}/consent submitClientConsent Registra a decisao de consentimento do proprio participante (auto-aceite/auto-rejeicao)

client-packages

Download do pacote DEX assinado vinculado ao experimento/versao

Método Caminho operationId Resumo
GET /api/experiments/{experimentId}/client-package downloadAndroidClientPackage Baixa o pacote .hdtclient.zip MDPL do contrato

cddl

Heartbeat de status de coleta CDDL/CDAL (metadados, nunca leituras de sensor)

Método Caminho operationId Resumo
POST /api/experiments/{experimentId}/clients/{clientId}/cddl-status reportCddlStatus Heartbeat de status de coleta CDDL/CDAL do participante
GET /api/cddl-status listCddlStatus Lista o ultimo heartbeat CDDL/CDAL de todos os participantes, todos os experimentos
GET /api/experiments/{experimentId}/cddl-status listCddlStatusByExperiment Lista o ultimo heartbeat CDDL/CDAL dos participantes deste experimento

aggregation-callback

Callback legado do agregador Docker (experimentos ainda nao convertidos ao padrao "aggregator responde direto" — ver BL-244/BL-250)

Método Caminho operationId Resumo
POST /api/experiments/{experimentId}/rounds/{roundId}/aggregation-result reportAggregationResult Callback do agregador Docker com o resultado da agregacao (caminho legado, pre-BL-244/BL-250)

Explorador Interativo (Swagger UI)

Visualização interativa

O explorador abaixo carrega a biblioteca swagger-ui-dist no navegador. Em ambientes totalmente offline, utilize as tabelas acima ou baixe o arquivo YAML diretamente.