Portal de Engenharia BenCorp

Documentação interna do Controle de Vigências, a plataforma que a engenharia de segurança do trabalho usa para acompanhar os documentos dos clientes (PGR, PCMSO, laudos e afins), conduzir a elaboração de programas e gerar relatórios, integrada de ponta a ponta com o SOC.

Esta documentação é de uso interno. Ela explica, em três frentes:

• Telas: o que cada tela do portal faz e como a pessoa usa no dia a dia.
• Rotas: os endpoints da API, o que cada um recebe e devolve, e o nível de acesso.
• Integrações: como o portal conversa com o SOC, com o datalake (via N8N), com o e-mail e como o deploy chega no servidor.

Para quem é

• Time de engenharia e relacionamento: entender o fluxo das telas e das etapas.
• Time de tecnologia (TI): entender as rotas, as integrações e o modelo de acesso para dar manutenção, integrar outro sistema ou investigar um problema.

O que o portal faz, em uma frase

Sincroniza os documentos e vigências do SOC, mostra o estado de conformidade por cliente, permite lançar e alterar vigências pelo robô, conduzir a elaboração de programas em um quadro de etapas, gerar a Ordem de Serviço e o relatório de riscos psicossociais, e expor tudo isso por uma API.

Como ler esta documentação

Comece por Arquitetura para ter o mapa geral dos componentes. Depois navegue pelas seções conforme a sua necessidade. A barra lateral segue a ordem: Introdução, Arquitetura, Telas, Rotas, Integrações e Segurança.

Convenções

As telas são descritas pelo nome que aparece no menu lateral do portal. As rotas usam o caminho real da API (prefixo /api). Onde há regra de negócio, ela está escrita por extenso.