Integração Sistema GED

A integração padrão entre Edusoft e sistemas GED tem como objetivo manter o anexo de um documento entregue centralizado no sistema GED de preferência da instituição. Para que essa integração aconteça, são necessárias algumas configurações prévias. Veja abaixo:

1) Cadastro do documento com o código do GED informado:
O documento que irá receber o anexo deve estar previamente cadastrado no sistema GED.
O código do documento recebido no GED, deve ser informado no Mentor (Módulo Comum > Documentos Pessoais), conforme abaixo:

2) Configuração de acesso ao GED feita no Mentor
Na tela abaixo é necessário informar os dados de acesso ao sistema GED (tipo de sistema, operador, chave e serviço).
Ver exemplo na tela abaixo :
??? TELA ???

A integração com sistema GED pode acontecer em 3 momentos. Abaixo descrito cada momento.

1) Quando feito a entrega de um documento e colocado um anexo
Neste momento, o anexo do documento é enviado ao sistema GED.

O sistema faz uma requisição “POST” para o endereço: <caminho_configurado>/servlet/apostdocumento
Nessa chamada são passados alguns parâmetros (Query Params) e alguns parâmetros no body (form-data).
Veja abaixo um exemplo feito no PostMan:

A resposta da integração se dará com STATUS 200 e no body será um JSON com o campo “codMsg”.
Se o valor deste campo for zero “0”, significa que a integração foi realizada com sucesso.
Caso não seja zero, o sistema lê o campo “dscMsg” para saber o motivo do erro.

Durante o envio do anexo, caso a pessoa que irá receber o anexo ainda não esteja integrado ao GED (não possui código do GED), o sistema faz primeiro uma requisição ao GED para enviar essa pessoa.

Para isso, o sistema faz uma requisição “POST” para o endereço: <caminho_configurado>/servlet/apostpessoa Nessa chamada são passados alguns parâmetros (Query Params) e alguns parâmetros no body (form-data).
Veja abaixo um exemplo feito no PostMan:

A resposta da integração se dará com STATUS 200 e no body será um JSON com o campo “codMsg”.
Se o valor deste campo for zero “0”, significa que a integração foi realizada com sucesso.
Caso não seja zero, o sistema lê o campo “dscMsg” para saber o motivo do erro.


2) Quando visualizado o anexo de um documento entregue
Neste momento, o anexo será buscado no sistema GED.

O sistema faz uma requisição “POST” para o endereço: <caminho_configurado>/servlet/agetdocumento
Nessa chamada são passados alguns parâmetros (Query Params) e alguns parâmetros no body (form-data).
Veja abaixo um exemplo feito no PostMan:

A resposta da integração se dará com STATUS 200 e no body pode vir um binário com o anexo ou uma string.
Em caso de vir o binário é porque deu sucesso. Caso venha string deu erro. Então é lido o “codMsg” e “dscMsg” para saber o erro retornado.


3) Quando retirado a entrega de um documento da pessoa
Neste momento, é mandado uma solicitação ao GED de exclusão de anexo.

O sistema faz uma requisição “POST” para o endereço: <caminho_configurado>/servlet/adeletedocumento
Nessa chamada são passados alguns parâmetros (Query Params) e alguns parâmetros no body (form-data).
Veja abaixo um exemplo feito no PostMan:

A resposta da integração se dará com STATUS 200 e no body será um JSON com o campo “codMsg”.
Se o valor deste campo for zero “0”, significa que a integração foi realizada com sucesso.
Caso não seja zero, o sistema lê o campo “dscMsg” para saber o motivo do erro.

4) Enviar documento para o MentorWeb
Este endpoit irá efetuar a entrega de um documento. Caso o status do documento seja “Entregue” e tiver configurado para integrar com o GED neste momento o documento será enviado à plataforma do GED, sendo outro status (reprovado, aguardando aprovação)o anexo ficará retido no mentor até que o status do documento seja alterado para entregue. endpoit:
/v1/documentosEntregue/grava

O sistema faz um requisição Post para o endereço configurado <api do MentorWeb>/v1/documentosEntregue/grava
E envia os seguinte dados: Anexos e o corpo é que um Json.

Agora o endpoint retornar alguns parâmetros novos:

  "id": id do documento entregue criado (numero)
  "statusDocumentoEntregue": status do documento inserido (String [AGUARDAPROV, ENTREGUE, REPROVADO])
  "observacao": campo de observação do documento entregue, ele é populado quando ocorre algum erro tratado (String)

5) Alterar Status de um documento no MentorWeb
O sistema faz um requisição Post para o endereço configurado <api do MentorWeb>/v1/documentosEntregue/alterarStatus/{idDocumento}
Caso o status seja “Entregue” e tiver configurado para integrar com o GED neste momento o documento será enviado a plataforma do GED.

E envia os seguinte dados: novoStatus e motivoRecusa + {idDocumento}.

6) Recuperação de documentos do MentorWeb
Como agora os documentos são gravados no ged alguns endpoints foram alterados para quando o arquivo for um arquivo integrado com o GED ele recuperar o arquivo do sistema ged. Endpoints:
<api do MentorWeb>/v1/downloadArquivoPorId (endpoint recupera da TB_ARQUIVO)
<api do MentorWeb>/v1/downloadArquivoInternoPorId (endpoint recupera da TB_IMAGEM)

6.1) Requisição:
6.2) - Retorno: