Conector de Diplomas Externos - Release note
(Apenas para Universidades Federais que aderiram ao módulo de registradora para terceiros)
Aderente ao XSD V1.05 do MEC
Atenção:
- 1.Para as IES que ainda não haviam atualizado o Conector para a versão 0.21.1, antes de atualizar para a versão 0.22.0 é necessário abrir um chamado para o e-mail [email protected] solicitando a adição da configuração dos documentos Representação Visual do Histórico Escolar e Representação Visual do Currículo Escolar.
- 2.É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.
- 3.Os volumes dos containers do Conector e do Banco de Integração devem ser sempre persistidos, além da aplicação de estratégias de backup.
- 4.O MEC sinalizou que os documentos do tipo Currículo Escolares (já regulamentados na versão 1.05 do normativo) serão utilizados para confrontar com o Histórico Escolar Final de cada aluno com o objetivo de verificar se foram cumpridos todos os requisitos para conclusão do curso. É de responsabilidade da IES conhecer as instruções sobre o Currículo Escolar e emitir os Históricos Escolares em conformidade.
- 5.A IES devem ser cautelosas em relação ao downloads dos arquivos (principalmente já assinados). Algumas ferramentas (como o Swagger) manipulam o XML, por se tratar basicamente de um arquivo de texto, na hora do download. Esse processo pode invalidar o arquivo. O download de documentos reais deve sempre ser realizado via código ou cURL fazendo chamada direto para a API Rest do Conector.
Adicionado
● Logs mais descritivos sobre o erro de incompatibilidade de versão do conector com as configurações de documentos.
● Informações adicionais sobre certificados listados pelo RAPSign.
● Possibilidade de configuração de múltiplas URLs de redirecionamento para configuração do certificado em nuvem NeoID no RAPSign.
Modificado
● Geração dos id nas tags de nós que são assinados.
● Melhorias no log de processamento e de erro nos processos de geração, assinatura, registro e revogação de documentos.
Corrigido
● Falha na transição de estado de representações visuais recém geradas.
● Atributos que deveriam ser opcionais no esquema JSON da Documentação Acadêmica.
Observações:
Obs.: O MEC sinalizou que os documentos do tipo Currículo Escolares (já regulamentados na versão 1.05 do normativo) serão utilizados para confrontar com o Histórico Escolar Final de cada aluno com o objetivo de verificar se foram cumpridos todos os requisitos para conclusão do curso. É de responsabilidade da IES conhecer as instruções sobre o Currículo Escolar e emitir os Históricos Escolares em conformidade.
Obs2.: Para os Arquivos Auxiliares (Lista de Diplomas Anulados, Arquivo de Fiscalização da Registradora e Arquivo de Fiscalização da Emissora), existem duas formas de lista os diplomas que farão parte dessa lista:
● Inserindo os dados completos (definidos pelo MEC para cada um dos Arquivos Auxiliares) para os diplomas ;
● Inserindo o docId (e dados complementares, quando necessário) do diplomas. Nesse caso o docId informado deve ser sempre de documentos do tipo 2 (diploma digital).
Obs3.: Segundo recomendação do MEC, sempre que houver a troca de XSD entre expedição e emissão dos documentos, deve-se alinhar a data de expedição (informada no arquivo XML) para funcionar com a versão do XSD mais atual.
Obs4.: A versão 1.04.1 do normativo criou o elemento Assinantes tanto para a Documentação Acadêmica quanto para o Diploma Digital. O elemento Assinantes é opcional e informa os cargos dos assinantes do nó DadosDiploma (para a Documentação Acadêmica) e do nó DadosRegistro (para o Diploma Digital). Caso esteja presente, deve possuir o CPF e cargo de todas as autoridades que assinaram os respectivos nós. Sendo assim, se optarem por preencher esse elemento (que é opcional), cada IES deve gerenciar quem serão os assinantes que irão assinar aquele documento específico já levando em consideração se algum substituto irá substituir um assinante titular.
Obs5.: Os certificados de Pessoa Jurídica que assinam a Documentação Acadêmica, Diploma Digital e o Histórico Escolar devem possuir os mesmo dados informando nos elementos da IES Emissora e da IES Registradora.
Obs6.: A versão 1.04.1 do normativo criou o elemento “ambiente” para a Documentação Acadêmica, Diploma Digital e o Histórico Escolar. Para os documentos oficiais emitidos em produção, o elemento deve ser preenchido com o termo “Produção”.
Obs7.: Os documentos anexos à Documentação Acadêmica, mesmo os que sejam assinados digitalmente, devem estar no formato PDF/A.
Aderente ao XSD V1.05 do MEC
Atenção:
- 1.A partir da versão 0.22.0 do Conector Externo é possível receber documentação acadêmica externa das versões 1.04.1 (até 17 de julho de 2023) e 1.05. Para isso, o atributo data.Versão enviado no JSON do campo documentData deve ser igual a versão do XML que está sendo submetido.
- 2.É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.
- 3.Os volumes dos containers do Conector e do Banco de Integração devem ser sempre persistidos, além da aplicação de estratégias de backup.
- 4.A IES devem ser cautelosas em relação ao downloads dos arquivos (principalmente já assinados). Algumas ferramentas (como o Swagger) manipulam o XML, por se tratar basicamente de um arquivo de texto, na hora do download. Esse processo pode invalidar o arquivo. O download de documentos reais deve sempre ser realizado via código ou cURL fazendo chamada direto para a API Rest do Conector.
Adicionado
● Suporte a múltiplas versões de documentos externos (v1.04.1 até 17/07 e v1.05).
● Informações adicionais sobre certificados listados pelo RAPSign.
● Possibilidade de configuração de múltiplas URLs de redirecionamento para configuração do certificado em nuvem NeoID no RAPSign.
● Validação adicional do arquivo XML da Documentação Acadêmica Externa no início do processamento.
Modificado
● Algoritmo de geração do securityCode da Documentação Acadêmica Externa (hash <ID do diplomado, código EMEC do curso, código MEC da emissora, DataHora>).
● Geração dos id nas tags de nós que são assinados.
● Melhorias no log de processamento e de erro nos processos de geração, assinatura, registro e revogação de documentos.
Corrigido
● Exibição de assinaturas no visualizador de Documentação Acadêmica Externa.
● Atributos que deveriam ser opcionais no esquema JSON da Documentação Acadêmica.
Observações:
Obs.: Segundo recomendação do MEC, sempre que houver a troca de XSD entre expedição e emissão dos documentos, deve-se alinhar a data de expedição (informada no arquivo XML) para funcionar com a versão do XSD mais atual.
Obs2.: A versão 1.04.1 do normativo criou o elemento Assinantes tanto para a Documentação Acadêmica quanto para o Diploma Digital. O elemento Assinantes é opcional e informa os cargos dos assinantes do nó DadosDiploma (para a Documentação Acadêmica) e do nó DadosRegistro (para o Diploma Digital). Caso esteja presente, deve possuir o CPF e cargo de todas as autoridades que assinaram os respectivos nós. Sendo assim, se optarem por preencher esse elemento (que é opcional), cada IES deve gerenciar quem serão os assinantes que irão assinar aquele documento específico já levando em consideração se algum substituto irá substituir um assinante titular.
Obs3.: Os certificados de Pessoa Jurídica que assinam a Documentação Acadêmica e o Diploma Digital devem possuir os mesmo dados informados nos elementos da IES Emissora e da IES Registradora.
Obs4.: A versão 1.04.1 do normativo criou o elemento “ambiente” para a Documentação Acadêmica e o Diploma Digital. Para os documentos oficiais emitidos em produção, o elemento deve ser preenchido com o termo “Produção”.
Aderente ao XSD V1.05 do MEC
Atenção:
- 1.É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.
- 2.Os volumes dos containers do Conector e do Banco de Integração devem ser sempre persistidos, além da aplicação de estratégias de backup.
- 3.A IES devem ser cautelosas em relação ao downloads dos arquivos (principalmente já assinados). Algumas ferramentas (como o Swagger) manipulam o XML, por se tratar basicamente de um arquivo de texto, na hora do download. Esse processo pode invalidar o arquivo. O download de documentos reais deve sempre ser realizado via código ou cURL fazendo chamada direto para a API Rest do Conector.
Adicionado
● Rota para reiniciar o processamento de todas as assinaturas de um documento.
● Variável de timeout do servidor do Conector (default 10 minutos).
● Logs mais descritivos no daemon de finalização de assinaturas.
Modificado
● Rota de remoção de documentos com erro de inicialização de processamento
● String de comparação de versão na atualização de tipos de documentos. ● Rota de retentar assinatura de documentos para reiniciar apenas a última assinatura.
● Algoritmo de geração de código de segurança para documentações acadêmicas externas.
● Rota de retentar assinatura de documentos para reiniciar apenas a última assinatura.
● Melhorias na validação dos arquivos PDF/A da Documentação acadêmica.
Corrigido
● Rota de remoção de documentos com erro de inicialização de processamento.
● Falha de concorrência no acesso à configuração de tipos de documentos.
Observações:
Obs.: Segundo recomendação do MEC, sempre que houver a troca de XSD entre expedição e emissão dos documentos, deve-se alinhar a data de expedição (informada no arquivo XML) para funcionar com a versão do XSD mais atual.
Obs2.: A versão 1.04.1 do normativo criou o elemento Assinantes tanto para a Documentação Acadêmica quanto para o Diploma Digital. O elemento Assinantes é opcional e informa os cargos dos assinantes do nó DadosDiploma (para a Documentação Acadêmica) e do nó DadosRegistro (para o Diploma Digital). Caso esteja presente, deve possuir o CPF e cargo de todas as autoridades que assinaram os respectivos nós. Sendo assim, se optarem por preencher esse elemento (que é opcional), cada IES deve gerenciar quem serão os assinantes que irão assinar aquele documento específico já levando em consideração se algum substituto irá substituir um assinante titular.
Obs3.: Os certificados de Pessoa Jurídica que assinam a Documentação Acadêmica e o Diploma Digital devem possuir os mesmo dados informados nos elementos da IES Emissora e da IES Registradora.
Obs4.: A versão 1.04.1 do normativo criou o elemento “ambiente” para a Documentação Acadêmica e o Diploma Digital. Para os documentos oficiais emitidos em produção, o elemento deve ser preenchido com o termo “Produção”.
Aderente ao XSD V 1.05 do MEC
3. As IES devem ser cautelosas em relação ao download dos arquivos (principalmente já assinados). Algumas ferramentas (como o Swagger) manipulam o XML, por se tratar basicamente de um arquivo de texto, na hora do download. Esse processo pode invalidar o arquivo. O download de documentos reais deve sempre ser realizado via código ou cURL fazendo chamada direto para a API Rest do Conector.
- Suporte para a visualização gráfica de documentos v1.05 do diploma digital.
- Emissão de documentos da versão 1.05 do diploma digital.
- Emissão por Determinação Judicial (ver normativo).
- Emissão de Diplomas por Programa de Transferência Assistida (ver normativo).
- Sanitização de arquivos XML enviados pela rota de inserção de documentos.
- Visualização de arquivos XMLs com formatações específicas.
Obs1.: Segundo recomendação do MEC, sempre que houver a troca de XSD entre expedição e emissão dos documentos, deve-se alinhar a data de expedição (informada no arquivo XML) para funcionar com a versão do XSD mais atual.
Obs2.: A versão 1.04.1 do normativo criou o elemento Assinantes tanto para a Documentação Acadêmica quanto para o Diploma Digital. O elemento Assinantes é opcional e informa os cargos dos assinantes do nó DadosDiploma (para a Documentação Acadêmica) e do nó DadosRegistro (para o Diploma Digital). Caso esteja presente, deve possuir o CPF e cargo de todas as autoridades que assinaram os respectivos nós. Sendo assim, se optarem por preencher esse elemento (que é opcional), cada IES deve gerenciar quem serão os assinantes que irão assinar aquele documento específico já levando em consideração se algum substituto irá substituir um assinante titular.
Obs3.: Os certificados de Pessoa Jurídica que assinam a Documentação Acadêmica, Diploma Digital e o Histórico Escolar devem possuir os mesmos dados informados nos elementos da IES Emissora e da IES Registradora.
Obs4.: A versão 1.04.1 do normativo criou o elemento “ambiente” para a Documentação Acadêmica, Diploma Digital e o Histórico Escolar. Para os documentos oficiais emitidos em produção, o elemento deve ser preenchido com o termo “Produção”.
Aderente ao XSD V 1.04.1 do MEC
17/10/2022
- 1.É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.
- 2.Os volumes dos containers do Conector e do Banco de Integração devem ser sempre persistidos, além da aplicação de estratégias de backup.
- Camada de validação de assinatura de tag para evitar que documentos sejam assinados em estados proibidos.
- Interceptadores de requisição para repetir a autenticação do RAP Conector no RAP Server.
- Log de erros de validação do MEC no campo aditionalInfo da rota de estado de um documento.
- Aba de informações adicionais no visualizador gráfico de documentos.
- Filtro de data na rota de listagem de documentos.
- Opção de atualização de dados de revogação na rota de atualização de documentos. Na rota PUT /documents/{docId} é possível atualizar as informações de revogação de um documento no campo revocationData: MotivoAnulacao (“reson”) e AnotacaoAnulacao (“notes”); que serão utilizados para geração da Lista de Diplomas Anulados.
- Limite de caracteres máximo aumentados para 5k no campo InformacoesAdicionais do JSON do diploma.
- Estratégia de upload da Documentação Acadêmica Externa para atender XMLs com características específicas.
- (breaking change) Para atender os motivos de revogação especificados pelo MEC na Lista de Diplomas Anulados, o campo ‘reason’ da rota POST /documents/{docId}/revoke deve receber um dos seguintes valores; [Erro de Fato, Erro de Direito, Decisão Judicial, Reemissão para Complemento de Informação, Reemissão para Inclusão de Habilitação ou Reemissão para Anotaçao de Registro. Também é possível informar na chamada de revogação o campo “notes” (AnotacaoAnulacao) que será utilizado para a geração da Lista de Diplomas Anulados.
- Upload de XML com formatações específicas.
- Visualização de documentação comprobatória que não suportava vários documentos do mesmo tipo.
- Documentação foi atualizada para indicar que a chamada de autorização da documentação acadêmica externa deve ser realizada quando o documento estiver no status 2.
- Falha que não atualizava o estado de documentos dentro de um grupo de documentos.
Obs1.: Segundo recomendação do MEC, sempre que houver a troca de XSD entre expedição e emissão dos documentos, deve-se alinhar a data de expedição (informada no arquivo XML) para funcionar com a versão do XSD mais atual.
Obs2.: A versão 1.04.1 do normativo criou o elemento Assinantes tanto para a Documentação Acadêmica quanto para o Diploma Digital. O elemento Assinantes é opcional e informa os cargos dos assinantes do nó DadosDiploma (para a Documentação Acadêmica) e do nó DadosRegistro (para o Diploma Digital). Caso esteja presente, deve possuir o CPF e cargo de todas as autoridades que assinaram os respectivos nós. Sendo assim, se optarem por preencher esse elemento (que é opcional), cada IES deve gerenciar quem serão os assinantes que irão assinar aquele documento específico já levando em consideração se algum substituto irá substituir um assinante titular.
Obs3.: Os certificados de Pessoa Jurídica que assinam a Documentação Acadêmica, Diploma Digital e o Histórico Escolar devem possuir os mesmo dados informando nos elementos da IES Emissora e da IES Registradora.
Obs4.: A versão 1.04.1 do normativo criou o elemento “ambiente” para a Documentação Acadêmica, Diploma Digital e o Histórico Escolar. Para os documentos oficiais emitidos em produção, o elemento deve ser preenchido com o termo “Produção”.
Aderente ao XSD V 1.04.1 do MEC
27/09/2022
- 1.É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.
- 2.Os volumes dos containers do Conector e do Banco de Integração devem ser sempre persistidos, além da aplicação de estratégias de backup.
- Aba de informações adicionais no visualizador gráfico de documentos.
- Filtro de data na rota de listagem de documentos.
- Opção de atualização de dados de revogação na rota de atualização de documentos. Na rota PUT /documents/{docId} é possível atualizar as informações de revogação de um documento no campo revocationData: MotivoAnulacao (“reson”) e AnotacaoAnulacao (“notes”); que serão utilizados para geração da Lista de Diplomas Anulados.
- Estratégia de upload da Documentação Acadêmica Externa para atender XMLs com características específicas.
- (breaking change) Para atender os motivos de revogação especificados pelo MEC na Lista de Diplomas Anulados, o campo ‘reason’ da rota POST /documents/{docId}/revoke deve receber um dos seguintes valores; [Erro de Fato, Erro de Direito, Decisão Judicial, Reemissão para Complemento de Informação, Reemissão para Inclusão de Habilitação ou Reemissão para Anotaçao de Registro. Também é possível informar na chamada de revogação o campo “notes” (AnotacaoAnulacao) que será utilizado para a geração da Lista de Diplomas Anulados.
- Documentação foi atualizada para indicar que a chamada de autorização da documentação acadêmica externa deve ser realizada quando o documento estiver no status 2.
- Falha que não atualizava o estado de documentos dentro de um grupo de documentos.
Obs1.: Segundo recomendação do MEC, sempre que houver a troca de XSD entre expedição e emissão dos documentos, deve-se alinhar a data de expedição (informada no arquivo XML) para funcionar com a versão do XSD mais atual.
Obs2.: A versão 1.04.1 do normativo criou o elemento Assinantes tanto para a Documentação Acadêmica quanto para o Diploma Digital. O elemento Assinantes é opcional e informa os cargos dos assinantes do nó DadosDiploma (para a Documentação Acadêmica) e do nó DadosRegistro (para o Diploma Digital). Caso esteja presente, deve possuir o CPF e cargo de todas as autoridades que assinaram os respectivos nós. Sendo assim, se optarem por preencher esse elemento (que é opcional), cada IES deve gerenciar quem serão os assinantes que irão assinar aquele documento específico já levando em consideração se algum substituto irá substituir um assinante titular.
Obs3.: Os certificados de Pessoa Jurídica que assinam a Documentação Acadêmica, Diploma Digital e o Histórico Escolar devem possuir os mesmo dados informando nos elementos da IES Emissora e da IES Registradora.
Obs4.: A versão 1.04.1 do normativo criou o elemento “ambiente” para a Documentação Acadêmica, Diploma Digital e o Histórico Escolar. Para os documentos oficiais emitidos em produção, o elemento deve ser preenchido com o termo “Produção”.
Aderente ao XSD V 1.04.1 do MEC
07/07/2022
- 1.É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.
- Esquemas XSD da versão 1.04.1 da documentação acadêmica externa e do diploma digital.
- Esquemas JSON da versão 1.04.1 do diploma digital.
- Aumento de verbosidade dos logs no fluxo de assinatura de documentos.
- Verificação de assinantes habilitados para assinar um documento.
- Filtragem por CPF na rota de listagem dos documentos.
- Data em que o documento foi assinado pelo assinador na rota de obter o estado atual do documento.
- Rota para atualização de tokens expirados.
- Atributos groupId, yourNumber e authorization ao listar documentos.
- Suporte a visualização em formato JSON na rota de visualização de documentos.
- Rota para a visualização gráfica de diplomas digitais.
- Algoritmo de geração de código de validação.
- (break change) Rota de atualização de documentos que permitia a atualização de metadados. Apenas o campo data do JSON deve ser enviado na rota PUT /documents/{docId}.
- Falha que não incluía documentos com erro de inicialização na rota de listagem de documentos.
- Modificação da arquitetura do RAPSign WEB na versão 0.3.8.
- Aprimorado o esquema de log e respostas de erro da API para incluir dados mais precisos.
- Rota de health check para incluir informações mais precisas de saúde do Conector e seus componentes.
- Suporte à inserção de documentos na versão 1.03 da documentação acadêmica externa e do diploma digital.
Obs1.: Segundo recomendação do MEC, sempre que houver a troca de XSD entre expedição e emissão dos documentos, deve-se alinhar a data de expedição (informada no arquivo XML) para funcionar com a versão do XSD mais atual.
Obs2.: A versão 1.04.1 do normativo criou o elemento Assinantes tanto para a Documentação Acadêmica quanto para o Diploma Digital. O elemento Assinantes é opcional e informa os cargos dos assinantes do nó DadosDiploma (para a Documentação Acadêmica) e do nó DadosRegistro (para o Diploma Digital). Caso esteja presente, deve possuir o CPF e cargo de todas as autoridades assinaram os respectivos nós. Sendo assim, se optarem por preencher esse elemento (que é opcional), cada IES deve gerenciar quem serão os assinantes que irão assinar aquele documento específico já levando em consideração se algum substituto irá substituir um assinante titular.
Obs3.: Os certificados de Pessoa Jurídica que assinam a Documentação Acadêmica e o Diploma Digital devem possuir os mesmo dados informando nos elementos da IES Emissora e da IES Registradora.
Obs4.: A versão 1.04.1 do normativo criou o elemento “ambiente” tanto para a Documentação Acadêmica quanto para o Diploma Digital. Para os documentos oficiais emitidos em produção, o elemento deve ser preenchido com o termo “Produção”.
Obs5.: Os documentos anexos à Documentação Acadêmica, mesmo os que sejam assinados digitalmente, devem estar no formato PDF/A.
Aderente ao XSD V 1.03 do MEC
07/02/2022
- Rota para atualização de tokens JWT expirados (refresh token).
- Rota de inserção de documentações acadêmicas externas e diplomas externos.
- Esquemas JSON da documentação acadêmica externa e diplomas externos.
- Atributo authorization ao buscar um documento.
- Atributos groupId, yourNumber e authorization ao listar documentos.
- Suporte a visualização em formato JSON na rota de visualização de documentos.
- Rota para a visualização gráfica de diplomas digitais.
- Rota de autorização de assinatura e registro de documentos.
- Esquema de autorização para impedir a continuidade do processamento de documentos não autorizados.
- Identificação automática de política de assinatura em documentações acadêmicas externas.
- Validação do arquivo XML das documentações acadêmicas externas.
- Variável de ambiente para habilitar/desabilitar a validação do arquivo XML das documentações acadêmicas externas.
- (break change) Rota de atualização de documentos que permitia a atualização de metadados.
Comandos para realizar backup do banco de dados da integração
/sudo docker exec -it <containerId> bash
#pg_dump -U rapproduser -W rapproddb > db.dump
sudo docker cp <containerId>:/db.dump ./
Last modified 3mo ago