| Data de elaboração | 13/06/2022 |
| Responsável pelo estudo | Rafael Passos dos Santos (Assessor) Lucas de Souza e Sousa (Assessor) |
| Equipe do estudo | Gustavo Felix Gomes (Assessor)
Rafael Passos dos Santos (Assessor) André Honório de Andrade Silva (Tecnico) Emanuel Rufino Alcantara de Lima (Analista) Alef Carvalho (Analista) Euriane Nogueira (Product Owner) |
| Alvo | Portal do Cidadão |
| Origem | Implementação: Cidadão realizar assinatura avançada da solicitação de atendimento online no Portal do Cidadão |
| Objetivo | Analisar a melhor abordagem para o Cidadão realizar assinatura da solicitação de atendimento online no projeto Portal do Cidadão conforme a User Story: “Eu como vingadores, preciso realizar um estudo para o cidadão realizar assinatura da solicitação de atendimento online" presente na Sprint número 101 do time Vingadores. |
| Documentação correlata | https://documentos.sistemas.ro.gov.br/books/assine-aqui/page/tutorial-integracao-da-assinatura-avancada-ao-seu-sistema
https://govdoc-api.development.local/swagger/index.html https://whimsical.com/fluxo-assinatura-NxKxdgS5tGX65WBJwi6ncq https://assineaqui.development.local/AssinaturaExterna/AssinarDocumento?documentoId=id&nomeDoDocumento=PortariaXYZ&sistemaClientId=13fb3448-9037-42d8-a852-ebf1b468a832&corpoDoDocumento=%3Ch1%3EOPA%3C/h1%3E |
| Observações | O presente estudo pretende também pretende levantar as Historias dos cars para a Sprint |
¶ Objetivo
¶ JUSTIFICATIVA
¶ RESULTADOS ESPERADOS
¶ Introdução
¶ Desenvolvimento - Cidadão realizar assinatura avançada da solicitação de atendimento online no Portal do Cidadão
¶ FUNCIONAMENTO
Após carregar a tela, ele pedirá seu CPF para gerar um código de confirmação com validade de 5 minutos que será enviado para seu e-mail cadastrado no Gov.br, assim que receber o código de confirmação no seu e-mail, é só inseri-lo no seu respectivo campo, também é possível reenviar o código caso seja necessário, depois de informado o código é só clicar em assinar e uma tela confirmando a assinatura irá aparecer.
Segundo as informações disponíveis para implementar assinatura será necessário:
- Id do documento que deseja assinar;
- Nome do documento que deseja assinar;
- Id do sistema cliente (ClientId) que fará a integração;
- String do corpo do documento que deseja assinar (HASH do documento)
- Com essas informações é possível criar a URL da assinatura, onde serão enviado os parâmetros.
¶ IMPLEMENTAÇÃO
- Id do documento que deseja assinar;
- Nome do documento que deseja assinar;
- String do corpo do documento que deseja assinar (HASH do documento)
- Além disso, quando a solicitação for salva, ela precisa salvar essas informações de cima também na solicitação.
¶ Fluxo da criação do documento no GOV.DOC
¶ Criação do documento no GOV.DOC
https://govdoc-api.development.local/swagger/index.html
A Criação deverá ser realizada na Controller de Documentos na Action PostDocumentoUsuarioExterno
/Documentos/PostDocumentoUsuarioExterno - Como na imagem a baixo:
- Protocolo da solicitação
- Data e Hora da solicitação
- Área de atendimento (Departamento solicitado)
- Nome do solicitante
- Serviço solicitado
- CPF Anonimizado
- Conteúdo das respostas, se tiver
E o campo Usuário devera ter
- Nome do Cidadão
- CPF Anonimizado
Logo baixo podemos ver Dois exemplos de um objetos que podem ser enviados, onde o Corpo do documento se trata de uma String.
{
"titulo": "Solicitação do servico - Cadastro de Acesso ao Programa Mulher Protegida - Menor de 18 anos",
"conteudo": "Protocolo da solicitação, Data e Hora da solicitação, Área de atendimento, Prazo Restante, Prazo Total, Conteúdo da resposta, se tiver",
"clientId": "35ac2a48-c839-4130-a273-47139bb5a7ea",
"tipoDeDocumento": "Parecer",
"usuario": {
"nome": "Lucas de S.",
"cpf": "034440*****",
"email": "string"
},
"restrito": false
}
Se tudo der certo o sistema deve retorna pro detalhes da solicitação com o botão assinar visível, trazendo junto com as informações do detalhes da solicitação, o campo id e HASH do documento.
¶ Assinatura com Assine Aqui
O primeiro era a implementação da API do assine aqui e o Gov.br integrado com o Portal do cidadão, nessa opção não abrira outra aba do navegador e a assinatura seria realizada em uma tela dentro do próprio portal do Cidadão, com o layout do Portal.
Toda via, o assine aqui com Gov.br não usa a API do assine aqui, o projeto é somente web, e tal abordagem se tornou inviável em vista que é obrigatório por decreto o uso do assine aqui, com seu layout, para o cidadão ter total entendimento que está usando o sistema.
A outra abordagem é mais simples, usando o assine aqui, entretanto em vez de abri a nova aba quando o Cidadão for assinar, o portal ira redirecionar pro assine aqui através da tag html:
<a class="btn btn-primary" href="link do assine aqui">Assinar</a>
¶ Obter Assinatura
https://assineaqui-api.development.local/index.html
https://assineaqui-api.staging.local/index.html
https://assineaqui-api.production.local/index.html
a assinatura pode ser obtida pela Action (/api/Assinaturas/BuscarPorDocumentoId), passando os parâmetros documentoId e sistemaClientId, como na imagem abaixo:
¶ IMPLEMENTAÇÃO E HISTÓRIA DE USUÁRIO
| HISTÓRIA | PONTUAÇÃO | PRODUTO |
|---|---|---|
| 1 - Integração do alpha solicitações API com Gov Doc | 5 | Alpha Solicitações Api e Gov Doc |
| 2 - Parte 1 - Criar um documento no Gov doc com as informações da solicitação, , ao realizar uma solicitação no Portal do Cidadão | 5 | Gov Doc e Alpha Solicitações Api |
| 3 - Parte 2 - Após a criação do documento, obter o retorno dele e gerar um Hash com o corpo do documento e salvar ele e o id do documento junto a solicitação realizada no Portal do Cidadão | 8 | Gov Doc e Alpha Solicitações Api |
| 4 - Parte 3 - Obter o Id do documento e o Hash do documento criado no Alpha solicitação quando Cidadão for pra tela de detalhes da solicitação | 3 | Alpha Solicitações Api e Portal do Cidadão |
| 5 - Realizar a assinatura enviando o Id, Hash e nome do documento por parâmetro | 3 | Portal do Cidadão |
| 6 - Integração do Portal do Cidadão com Api do Assine Aqui | 5 | Portal do Cidadão e Api do Assine Aqui |
| 7 - Cidadão visualizar assinatura | 5 | Portal do Cidadão |
| 8 - Atendente visualizar assinatura | 5 | Alpha Solicitações Web |
| 9 - Criar um novo tipo de documento no gov doc para a solicictação. | 2 | Gov Doc |
| TOTAL | 41 |
¶ POSSÍVEIS PROBLEMAS NA UTILIZAÇÃO
O principal é o envio do hash do documento por parâmetro na URL do assine aqui
Performance do Gov doc em relação a grande quantidade de request, pois será criado um documento toda vez que for realizado uma solicitação online no Portal do Cidadão.