Ir para o conteúdo principal

Implementar Nova API do E-Estado


Data de elaboração 16/12/2020
Responsável pelo estudo
  1. Rafael Passos dos Santos (Assessor)
Equipe do estudo
  1. Gustavo Felix Gomes (Assessor)
  2. Rafael Passos dos Santos (Assessor)
  3. Alexsandro Rocha Fernandes (Assessor)
  4. André Honório de Andrade Silva (Tecnico)
  5. Emanuel Rufino Alcantara de Lima (Analista)
  6. Euriane Nogueira (Product Owner)
  7. Lucas de Souza e Sousa (Estagiario)
Alvo Portal do cidadão
Origem

Implementação: Troca de API do E-Estado

Objetivo

  • Avaliar qual a necessidade de trocar para a nova API do E-Estado, quais serão os sistemas afetados por essa implementação, quais as mudanças necessárias e possíveis impedimentos.
  • Identificar a Solução, as Histórias de Usuários, Débitos Técnicos e quais possíveis impedimentos podem dificultar a integração com a Nova API do E-Estado.
Documentação correlata
Observações O presente estudo pretende também pretende levantar as Historias dos cards para a Sprint 
1. Objetivo

Avaliar qual a necessidade de trocar para a nova API do E-Estado, quais serão os sistemas afetados por essa implementação, quais as mudanças necessárias e possíveis impedimentos.

Identificar a Solução, as Histórias de Usuários, Débitos Técnicos e quais possíveis impedimentos podem dificultar a integração com a Nova API do E-Estado.

2. Introdução

Atualmente os sistemas dos Vingadores estão consumindo uma API do E-Estado feito em C# que não está mais recebendo manutenção devido essas situação foi solicitado a troca para a Nova API.

3. Desenvolvimento - Implementar Nova API do E-Estado

1. CENÁRIO ATUAL

Atualmente todos os sistemas desenvolvidos pelos vingadores estão consumindo uma API criado em C# pelo Andrews do Time Esquadrão, nessa API é possível informar o CPF de um Servidor e a mesma retornará seus dados e suas movimentações. A Movimentação é importantíssima para alguns sistemas como o Portal do Servidor e Alpha pois é possível pegarmos a lotação atual do servidor e executar certas funcionalidades de acordo com essa informação.

Nesse mês de fevereiro ficamos ciente de uma nova API do E-Estado e foi solicitado que fosse realizado a troca da consulta por CPF dos Servidores para essa nova API em todos os Sistemas dos Vingadores. Esses Sistemas são:

- Alpha

- Portal do Servidor

- Comunique-se (Atualmente com os Titãs)

- SID (Atualmente com os Titãs)

2. SOLUÇÃO

Durante a criação desse estudo foram encontrado duas possíveis soluções.

2.1 PRIMEIRA SOLUÇÃO

Não alterar os Sistemas mantendo a API criada em C# e caso seja necessário realizar manutenção na mesma, desta maneira não será necessário realizar mudanças nos sistemas atualmente somente realizar manutenção na API atual se necessário.

2.2 SEGUNDA SOLUÇÃO

Realizar a Troca para a nova API do E-Estado, será necessário realizar a criação da Chave na Central do Desenvolvedor, após liberação e aprovação da chave realizaremos a integração com a Nova API em cada aplicação listada anteriormente. Por estarmos utilizando Orientação a Objeto a implementação ficará mais fácil sendo necessário realizar ajustes somente em uma parte de cada aplicação agilizado e facilitando o processo.

3. HISTÓRIAS DE USUÁRIO

As Histórias de usuário e débitos técnicos abaixo são referentes a segunda solução apresentada.

O que? Pontos Regras Produto
Realizar Integração com a nova API do E-Estado no Portal do Servidor. 5

- Criar Chave na Central do Dev.

Portal do Servidor

Realizar Integração com a nova API do E-Estado na API Alpha Serviços 3

- Criar Chave na Central do Dev.

API Alpha Serviços

Realizar Integração com a nova API do E-Estado na API Alpha Solicitação. 3

- Criar Chave na Central do Dev.

API Alpha Solicitação

Realizar Integração com a nova API do E-Estado no Alpha Serviço 3

- Criar Chave na Central do Dev.

Alpha Serviço

Realizar Integração com a nova API do E-Estado no Alpha Solicitação. 3

- Criar Chave na Central do Dev.

Alpha Solicitação

4. POSSÍVEIS IMPEDIMENTOS

Uma possível impedimento que pode ocorrer e uma das rotas da nova API não retornar um dos dados que precisamos em nossos sistemas impedindo uma utilização dessa API. Mas é pouco provável que isso aconteça.

4. Conclusão

Não será tão trabalhoso realizar essa alteração para a nova API do E-Estado mas também é possível realizarmos manutenção na API atual em C# evitando assim a realização das Histórias de Usuários acima.

5. Referências