Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Toda a comunicação entre o ERP da instituição e o Conector Local é feito via API de Comunicação.
A documentação da API de Comunicação pode ser acessada e testada em tempo real via swagger no próprio Conector Local na URL: http://:/docs/ExternalDocument/.
A porta padrão para a API de comunicação e para acesso a documentação é a 80.
Ela pode ser alterada no arquivo de configuração do docker-compose.
Outra forma de acessar a documentação da API de Comunicação é a partir do arquivo openapiexternal.json que encontra-se anexado na pasta de scripts desta documentação de integração.
Esse arquivo pode ser renderizado em qualquer visualizador de documentação swagger, a exemplo do Swagger Editor.
Além da documentação do Swagger, também é disponibilizada às instituições documentação para uso com o Postman1.
O conector para diplomas externos tem como objetivo descrever de forma resumida os passos para instalação e execução inicial do Conector para Geração de Diplomas Externos.
Instituições que têm a prerrogativa para registrar documentos de outras instituições poderão utilizar essa funcionalidade para inserir a documentação acadêmica da IES Emissora e, a partir disso, gerar e assinar o Diploma Digital Externo.
Com início na versão 0.12.0 do Conector, essa funcionalidade estará disponível na mesma imagem do Conector que realiza a emissão de documentos próprios.
O procedimento de configuração e instalação continuam os mesmos das versões anteriores.
O funcionamento da emissão de Diplomas Externo está inserido no seguinte contexto:
A IES Emissora gera e assina o XML de Documentação Acadêmica do seu aluno concluinte;
A IES Emissora envia o XML de Documentação Acadêmica para a sua IES Registradora via canal acordado entre as partes (a troca desses arquivos não faz parte do escopo do serviço);
A validação das condições de registro dos diplomas de terceiros é feita pela IES Registradora (a nova versão do Conector valida a estrutura da Documentação Acadêmica inserida e fornece apoio na visualização do XML gerado pela IES Emissora);
O registro do diploma de terceiros é feito pela IES Registradora no seu livro digital ou tradicional (assim como no fluxo de emissão de Diplomas Próprios);
A nova versão do Conector é usada para gerar o arquivo do diploma no formato XML reproduzindo fielmente as informações do XML da Documentação Acadêmica assinado pela IES Emissora e usando as informações de registro produzidas pela IES Registradora;
A IES Registradora confere cada arquivo XML de diplomas de terceiros antes de assinar;
A IES Registradora, através do(s) seu(s) signatário(s) designado(s), é quem controla a assinatura final do arquivo XML de diplomas de terceiros, fechando o ciclo;
A IES Registradora envia o XML de Diploma Digital registrado e assinado para a IES Emissora via canal acordado entre as partes (a troca desses arquivos não faz parte do escopo do serviço);
Com o RAPSign configurado e instalado (ver documentação específica).
O processo de assinatura é semelhante aos Diplomas Digitais Próprios.
Depois que a instituição solicitar a habilitação da funcionalidade de emissão de Diplomas Externos, no RAPSign aparecerá um 9 novo filtro para acesso à assinatura de documento deste tipo, conforme mostrado na imagem abaixo.
A configuração mínima de assinaturas para o Diploma Digital Externo contém as seguintes assinaturas:
eCPF Assina Diploma Digital (DadosRegistro);
eCNPJ (Certificado Institucional) Assina Diploma Digital com assinatura de arquivamento.
Passo a passo dos Procedimentos para Instalação do Conector
Para habilitar a funcionalidade é necessário solicitar a RNP o cadastro da IES Registadora no serviço. Essa solicitação pode ser realizada pelo Canal de Atendimento (atendimento@rnp.br).
Para atualizar o Conector deve-se executar o seguinte comando utilizando o docker-compose mais atual enviado junto à documentação:
Caso exista a versão mais recente do Conector, esta será baixada automaticamente. Após isso, basta reiniciar os containers.
Após o registro dos documentos é possível realizar algumas ações sobre o mesmo, quais sejam:
Suspensão e reativação de um documento em razão de alguma eventualidade que necessite que o Diploma seja suspenso temporariamente.
a. Rotas POST /documents/{docId}/suspend e POST /documents/{docId}/activate
2. Revogação de um documento caso seja necessário cancelá-lo para nova ré emissão.
a. Geralmente um diploma revogado deve ter todos os seus arquivos revogados (XML da Documentação Acadêmica, XML do Diploma e Representação Visual).
b. Para que um documento possa ser revogado, ele precisa estar no status 10 (Documento Válido) ou status 11 (Documento Suspenso).
c. Rota POST /documents /{docId} /revoke
3. Verificação de histórico de um Diploma
a. Utilizado para as consultas ao diploma pelo código de validação, conforme indicado na Nota técnica.
b. Retorna todo o histórico do documento que deverá ser exibido para um usuário consultante.
c. Rota GET /documents/{securityCode}/history
4. Refazer alguma parte do fluxo de processamento de algum dos documentos gerados e associados a um diploma:
a. Rotas
i. POST /documents/{docId}/restart-processing
ii. POST /documents/{docId}/retry-generation
iii. POST /documents/{docId}/retry-signature
iv. POST /documents/{docId}/retry-revocation
5. Baixar algum dos arquivos gerados durante o processamento dos documentos do diploma digital externo
a. É possível acessar o arquivo gerado ou o arquivo final assinado.
b. Rota GET /documents/{docId}/files
(Apenas para Universidades Federais que aderiram ao módulo de registradora para terceiros)
Aderente ao XSD V1.05 do MEC
Atenção:
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 atendimento@rnp.br solicitando a adição da configuração dos documentos Representação Visual do Histórico Escolar e Representação Visual do Currículo Escolar.
É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.
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.
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.
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:
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.
É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.
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.
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:
É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.
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.
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
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
É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.
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
É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.
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
É 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
Receber a Documentação Acadêmica gerada e assinada pela IES Emissora (fora do escopo do serviço);
2. Inserir a Documentação Acadêmica no Conector;
3. (opcional) Visualizar dados da Documentação Acadêmica;
4. Autorizar processamento da Documentação Acadêmica Externa;
5. Gerar o Diploma Externo através do envio dados de Registro gerados pela IES Registradora;
6. Assinar Diploma Digital Externo;
7. Fazer download do Diploma Digital gerado e assinado e enviar para a IES Emissora (fora do escopo do serviço).
Preencha os metadados JSON para geração de uma Documentação Acadêmica Externa
a. O JSON é composto pela seção meta e pela seção data.
i. A seção meta será usada para registro do documento após gerado no serviço RAP e para controle dos documentos.
1.1 Defina o groupId de forma única para um conjunto de documentos que representam um diploma. Considerando a emissão para um aluno, a Documentação Acadêmica, Diploma Digital e Representação visual correspondentes devem ter o mesmo groupId para o referido aluno.
ii. A seção data será usada para indexar o XML da Documentação Acadêmica Externa.
iii. No campo documentFile, anexe o XML da Documentação Acadêmica Externa enviada pela IES Emissora.
b. Envie o documento para iniciar o seu processamento usando a rota POST /documents da API de Comunicação. Para o processamento de uma documentação acadêmica, o código do tipo é 7.
c. Quando o documento estiver no status 2, é possível visualizar a documentação acadêmica enviada pela IES Emissora. Para isso acesse a URL: <IP_do_Conector>:/documents/{docId}/view/DocumentacaoAcademica O XML da Documentação Acadêmica será renderizado como apresentado na imagem abaixo.
d. Se as informações estiverem corretas, deve-se autorizar o processamento do documento através da rota PATCH /documents/{docId}/authorization.
e. O documento será processado e irá para o status 10.
a. O JSON é composto pela seção meta e pela seção data.
i. A seção meta será usada para controle dos documentos.
O campo groupId e yourNumber devem ser únicos.
ii. A seção data será usada para gerar o XML do Diploma Digital Externo. Os dados solicitados na seção data foram extraídos da própria norma do MEC.
b. Envie os dados em JSON do documento para iniciar o seu processamento usando a rota POST /documents da API de Comunicação. Para o processamento de um Diploma Digital Externo, o código do tipo é 6.
c. O processo de geração pode ser acompanhado com as rotas GET /documents e GET /documents/{docId}/state
i. GET /documents - lista documentos e estados atuais.
ii. GET /documents/{docId}/history - Lista todos os estados de um documento
d. Realize a coleta das assinaturas do XML do Diploma Digital Externo. No RAPSign aparecerá uma opção para filtrar documentos deste tipo.
e. Após a coleta, o Diploma Externo o documento irá para o status 10. Entretanto, esse tipo de documento NÃO é enviado para o serviço de Preservação da RNP.
Atenção: Os documentos do tipo Diploma Externo não são armazenados no serviço de Preservação da RNP. Os arquivos XMLs ficam armazenados apenas localmente em sistema de arquivo.
Foram enviados junto com a documentação Schema para validação dos arquivos JSON montados para geração do Diploma Digital Externo.
Esse esquema pode ser utilizado para verificar se os dados montados são válidos antes de enviarem para geração.
Essa validação pode ser feita por meio de ferramentas online como: https://www.jsonschemavalidator.net/ ou outras listadas em https://json-schema.org/implementations.html#validators.
Nas rotas PUT /documents/{docId} e POST /documents/{docId/revoke} é possível atualizar as informações de revogação de um documento: MotivoAnulacao (“reson”) e AnotacaoAnulacao (“notes”); que serão utilizados para geração da Lista de Diplomas Anulados. O objeto a ser enviados com os dados de revogação possui a seguinte estrutura:
{
"reason": "<MotivoAnulacao>",
"notes": "AnotacaoAnulacao"
}
Além disso, para atender os motivos de revogação especificados pelo MEC na Lista de Diplomas Anulados, o campo ‘reason’ 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ção de Registro.
