Integração de Matrículas (Novo Matrícula Web)

Orientações para implantação e utilização no SIG

Link do documento aqui exposto em PDF:

Passo 1

Para realizar a importação de uma matrícula, o primeiro passo é enviar uma requisição POST para o endpoint de entrada (/api/matricula/matriculas/importar), passando um JSON contendo as informações da matrícula. É essencial validar os dados antes de fazer a requisição para evitar erros no processo de importação. Se todas as informações estiverem corretas, a requisição será aceita e a importação será processada.

Open

Passo 2

Após a requisição, o pedido é registrado em uma fila, que garante que a importação das matrículas ocorra de forma assíncrona e não afete o desempenho do sistema. Para esse fim, usamos o rabbitMQ, uma ferramenta de mensageria.

Passo 3

Nessa etapa, desenvolvemos um Worker (Portais Service) para receber as tarefas da fila e processá-las em segundo plano. Quando o Worker recebe a tarefa, ele processa a importação das matrículas com todas as validações de contexto especificadas durante o planejamento desta demanda.

Passo 4

Após o processamento da importação, é importante registrar o retorno. Para isso, validamos a configuração do WebHooksRegional, um serviço que recebe notificações de eventos em tempo real. O registro do retorno inclui informações sobre a importação, como o ticket, o StatusCode e um array de Notificações.

Caminho:   SIG > Administrativo > Web Hooks > Cadastro de Web Hooks

Open

Passo 5

Por fim, um serviço consome a fila sig-webhooks e envia o retorno para a API do Regional, informando o resultado da importação.

Caminho:   SIG > Administrativo > Web Hooks > Evento