# Interfaces de Aplicação Managed documentation for Interfaces de Aplicação. # Visão Geral de Integração # Visão Geral de Integração | Campo | Valor | | --- | --- | | Distribuição | WCT Portuguese — OpenC5ISR | | Produto | OpenC5ISR | | Versão | 0.15.1 | | Implantação | `openc5isr-pt.wallacecorptech.com` | | Fonte | `/srv/wct/releases/OpenC5ISR-v0.15.0-20app-pt` | | Evidência | Contrato de referência e resumo da varredura | | Impressão digital da fonte | `e92dc1580aa26f7545815bcf40300b21bc5485b0a2ae46a715538a48365cc801` | | Estado | Linha de base gerada — revisão humana obrigatória | > **Limite de verificação:** Esta página combina orientação de projeto da plataforma com evidências estáticas da distribuição. Ela não comprova que todas as interfaces detectadas estejam habilitadas, acessíveis, seguras ou operacionais no ambiente implantado. ## Lista do contrato de integração | Área do contrato | Definição necessária | | --- | --- | | Propriedade | Produtor, consumidor, equipe responsável e autoridade de mudança. | | Endereçamento | URL base/tópico/caminho, ambiente e mecanismo de descoberta. | | Identidade e política | Autenticação, autorização, liberação e limite de tenant/edição. | | Contrato de dados | Esquema, tipo semântico, unidades, referência de coordenadas/tempo, identificadores e opcionalidade. | | Comportamento | Métodos/eventos, ordenação, idempotência, repetição, timeout, backpressure e modelo de erros. | | Escala | Taxa, tamanho, concorrência, retenção e metas de latência. | | Observabilidade | IDs de correlação, métricas, logs, auditoria e indicação de saúde. | | Ciclo de vida | Versionamento, compatibilidade, descontinuação, migração e responsabilidade de testes. | ## Resumo de interfaces observadas | Tipo de interface | Candidatos | | --- | --- | | REST/HTTP | 11 | | WebSocket | 8 | | Variáveis de ambiente | 244 | | Portas | 99 | | URLs externas | 1000 | | Arquivos semânticos | 22 | --- ## Notas do Mantenedor Adicione aqui notas de implantação revisadas por pessoas, correções, decisões, capturas de tela e links. O conteúdo fora do bloco gerado é preservado nas próximas execuções. # Endpoints REST # Endpoints REST | Campo | Valor | | --- | --- | | Distribuição | WCT Portuguese — OpenC5ISR | | Produto | OpenC5ISR | | Versão | 0.15.1 | | Implantação | `openc5isr-pt.wallacecorptech.com` | | Fonte | `/srv/wct/releases/OpenC5ISR-v0.15.0-20app-pt` | | Evidência | Extração estática de rotas | | Impressão digital da fonte | `e92dc1580aa26f7545815bcf40300b21bc5485b0a2ae46a715538a48365cc801` | | Estado | Linha de base gerada — revisão humana obrigatória | > **Limite de verificação:** Esta página combina orientação de projeto da plataforma com evidências estáticas da distribuição. Ela não comprova que todas as interfaces detectadas estejam habilitadas, acessíveis, seguras ou operacionais no ambiente implantado. ## Endpoints candidatos | Method | Path | Framework/evidência | Confiança | Fonte | | --- | --- | --- | --- | --- | | GET | `api_path` | express | server declaration | `drivers/openanalytics_agent.py` | | GET | `base_url` | express | server declaration | `drivers/openanalytics_agent.py` | | GET | `http://127.0.0.1:18782/api/integrations` | client-reference | client reference | `tests/compiled_deployment_smoke_test.py` | | GET | `id` | express | server declaration | `drivers/openanalytics_agent.py` | | GET | `lab_path` | express | server declaration | `drivers/openanalytics_agent.py` | | GET | `location` | express | server declaration | `drivers/openanalytics_agent.py` | | GET | `max_notebooks` | express | server declaration | `drivers/openanalytics_agent.py` | | GET | `name` | express | server declaration | `drivers/openanalytics_agent.py` | | GET | `owner` | express | server declaration | `drivers/openanalytics_agent.py` | | GET | `token` | express | server declaration | `drivers/openanalytics_agent.py` | | GET | `token_env` | express | server declaration | `drivers/openanalytics_agent.py` | ## Interpretação “Declaração de servidor” é evidência mais forte que referência de cliente, mas nenhuma comprova que a rota esteja montada no caminho base mostrado ou exposta nesta edição. Roteadores podem adicionar prefixos dinamicamente; middleware pode bloquear acesso; flags podem desabilitar handlers. ## Modelo de documentação de endpoint ```text METHOD /base/path Purpose: Authentication/authorization: Request headers/path/query/body schema: Semantic type and units: Success response: Error responses: Idempotency/retry behavior: Rate/size/timeout limits: Audit/correlation behavior: Example request and tested release: ``` ## Regra de aceitação Promova um endpoint candidato a API autoritativa somente após teste autenticado verificar status, esquema, política, comportamento de falha e mapeamento público/caminho base. --- ## Notas do Mantenedor Adicione aqui notas de implantação revisadas por pessoas, correções, decisões, capturas de tela e links. O conteúdo fora do bloco gerado é preservado nas próximas execuções. # Interfaces WebSocket # Interfaces WebSocket | Campo | Valor | | --- | --- | | Distribuição | WCT Portuguese — OpenC5ISR | | Produto | OpenC5ISR | | Versão | 0.15.1 | | Implantação | `openc5isr-pt.wallacecorptech.com` | | Fonte | `/srv/wct/releases/OpenC5ISR-v0.15.0-20app-pt` | | Evidência | Extração estática de WebSockets | | Impressão digital da fonte | `e92dc1580aa26f7545815bcf40300b21bc5485b0a2ae46a715538a48365cc801` | | Estado | Linha de base gerada — revisão humana obrigatória | > **Limite de verificação:** Esta página combina orientação de projeto da plataforma com evidências estáticas da distribuição. Ela não comprova que todas as interfaces detectadas estejam habilitadas, acessíveis, seguras ou operacionais no ambiente implantado. ## Endpoints candidatos | Endpoint | Evidência | Fonte | | --- | --- | --- | | `[invalid URL]` | url | `tests/raspbot_agent_smoke_test.py` | | `wss://.../` | url | `OPENLVC-DEMO.md` | | `wss://relay.example/` | url | `tests/openeyes_smoke_test.py` | | `wss://relay.example/ws/raspbot` | url | `open-eyes/index.html` | | `wss://relay.example/ws/raspbot` | url | `public/open-eyes/index.html` | | `wss://relay.example/ws/raspbot` | url | `tests/openeyes_smoke_test.py` | | `wss://your-relay/ws/raspbot` | url | `README-OPENEYES.md` | | `wss://your-relay/ws/raspbot` | url | `drivers/raspbot-openeyes.env.example` | ## Contrato de sessão necessário - URL/caminho base e se TLS (`wss`) é obrigatório. - Handshake de autenticação, autorização por função/ativo e comportamento de token na reconexão. - Envelope de mensagem, esquema/versão, ordenação, números de sequência e carimbos de tempo. - Heartbeat, timeout ocioso, reconexão/backoff e retomada. - Mensagem/taxa máxima, framing binário/mídia e política de backpressure/perda. - Cabeçalhos de upgrade Nginx, timeout do proxy e mapeamento público-backend. ## Verificação no navegador ```text Open developer tools → Network → WS Confirm HTTP 101 upgrade, authenticated session, expected message flow, heartbeat/reconnect behavior, and no credential leakage in URL/query strings. ``` --- ## Notas do Mantenedor Adicione aqui notas de implantação revisadas por pessoas, correções, decisões, capturas de tela e links. O conteúdo fora do bloco gerado é preservado nas próximas execuções. # Formatos e Contratos de Dados # Formatos e Contratos de Dados | Campo | Valor | | --- | --- | | Distribuição | WCT Portuguese — OpenC5ISR | | Produto | OpenC5ISR | | Versão | 0.15.1 | | Implantação | `openc5isr-pt.wallacecorptech.com` | | Fonte | `/srv/wct/releases/OpenC5ISR-v0.15.0-20app-pt` | | Evidência | Inventário de formatos de arquivo e padrão de integração | | Impressão digital da fonte | `e92dc1580aa26f7545815bcf40300b21bc5485b0a2ae46a715538a48365cc801` | | Estado | Linha de base gerada — revisão humana obrigatória | > **Limite de verificação:** Esta página combina orientação de projeto da plataforma com evidências estáticas da distribuição. Ela não comprova que todas as interfaces detectadas estejam habilitadas, acessíveis, seguras ou operacionais no ambiente implantado. ## Indicadores de formatos observados | Extensão/formato | Arquivos | | --- | --- | | `.json` | 76 | | `.csv` | 21 | | `.ttl` | 17 | | `.xml` | 7 | | `.rdf` | 4 | ## Requisitos de dados canônicos - Identificadores estáveis para entidades, observações, tarefas, produtos e eventos. - Unidades explícitas, referência de coordenadas, carimbos/escala temporal e incerteza. - Versão de esquema/semântica e comportamento de compatibilidade. - Origem/proveniência, confiança e linhagem de processamento. - Metadados de tratamento/liberação/retenção e controles de acesso no objeto. - Forma compacta de evento mais referência de artefato para imagens, vídeo ou conjuntos grandes. ## Regra de versionamento Prefira mudanças aditivas retrocompatíveis. Mudanças incompatíveis exigem nova versão de esquema/semântica, período de transição ou adaptador, testes explícitos de migração e notas de versão identificando produtores e consumidores afetados. --- ## Notas do Mantenedor Adicione aqui notas de implantação revisadas por pessoas, correções, decisões, capturas de tela e links. O conteúdo fora do bloco gerado é preservado nas próximas execuções.