| Data de elaboração | 11/06/2025 |
| Responsável pelo estudo | Jorge Luiz de Jesus Paiva Junior |
| Equipe do estudo | Caveiras |
| Alvo | Portal do Servidor/API-SIEP |
| Origem | Ajustes das Integrações: Identificação de possíveis inconsistências na comunicação entre o SIEP e o Portal do Servidor, que impactam diretamente na exibição das informações de escalas e plantões dos servidores. |
| Objetivo | Analisar as possíveis falhas na integração e propor soluções técnicas para garantir estabilidade, consistência e melhor experiência ao usuário. |
| Observações | Este estudo destaca a falta de tratamento de erros na comunicação com a API SIEP e propõe ações para melhorar a confiabilidade da integração. |
Este estudo visa identificar possíveis inconsistências na comunicação entre o sistema Portal do Servidor e a API SIEP, responsável por fornecer informações cadastrais e de plantões dos servidores públicos. A partir do diagnóstico, serão propostas ações para correção, melhoria contínua e aumento da confiabilidade da integração.
Nesta seção, será abordado a visão geral da integração atual entre os sistemas, os principais pontos de consumo da API SIEP, além da análise de inconsistências encontradas e os impactos associados.
A partir da análise dos pontos de integração, identificou-se que algumas actions não possuem tratamento adequado para falhas de comunicação com a API, o que pode comprometer a experiência do usuário e a integridade dos dados apresentados.
| Action | Descrição | Observação |
|---|---|---|
ObterTodosOsPlantoesDoServidorSiep |
Busca todos os plantões do servidor pelo SIEP | Sem tratamento de falha na comunicação com a API |
ObterPlantoesDoServidorSiep |
Busca os plantões do servidor pelo SIEP com ou sem carga horária | Sem tratamento de falha na comunicação com a API |
BuscarServidoresCompativeis |
Lista servidores com plantões compatíveis | Sem tratamento de erro e sem mensagem clara de falha |
EnviarSolicitacaoSiep |
Envia solicitação de troca de plantão via SIEP | Sem captura de exceções, retorno genérico |
SolicitacoesSiep |
Lista de solicitações de troca de plantão recebidas para o servidor | Sem tratamento de falha na comunicação com a API |
Nesta subseção, foram analisados os principais endpoints utilizados pelo Portal do Servidor para comunicação com a API SIEP na busca ou verificação de dados relacionados aos plantões e escalas dos servidores.
| Endpoint | Descrição | Método |
|---|---|---|
/v1/Plantoes/BuscarTodosPorMatricula?matricula= |
Busca todos os plantoes pela matrícula do servidor | POST |
/v1/plantoes/BuscarPorIdPlantao?plantaoId= |
Retorna plantão por plantaoId | GET |
/v1/Plantonista/PlantonistaExiste?cpf= |
Verifica se plantonista existe pelo CPF do servidor | GET |
/v1/solicitacoes/ListarSolicitacoesDeTrocaDePlantaoRecebidas?cpf= |
Retorna lista de solicitações recebidas de troca de plantão | GET |
/v1/plantoes/BuscarPorMatriculaParaTroca?matricula= |
Lista de plantões por matrícula para troca | POST |
ObterTodosOsPlantoesDoServidorSiep, ObterPlantoesDoServidorSiep, BuscarServidoresCompativeis, EnviarSolicitacaoSiep e SolicitacoesSiep, não tratam falhas na comunicação com a API SIEP, como timeouts, respostas nulas ou erros HTTP.HttpRequestException, TimeoutException, entre outras).Sendo desenvolvedor
Quero implementar tratamento de erros e falhas na comunicação com a API SIEP
Para que os usuários tenham uma experiência mais confiável e o sistema possa se recuperar de falhas
Este plano define as ações necessárias para corrigir os problemas atuais e melhorar a integração entre o Portal do Servidor e a API SIEP, garantindo que o sistema trate erros corretamente, ofereça mensagens claras ao usuário e seja mais confiável e fácil de manter.
A análise revelou que a ausência de tratamento de erros na comunicação entre o Portal do Servidor e a API SIEP pode comprometer a experiência do usuário e a confiabilidade dos dados exibidos. Corrigir essa lacuna é essencial para tornar a integração mais resiliente, transparente e segura para os usuários finais, além de facilitar o suporte técnico e a manutenção do sistema.