O Conector Local é responsável por executar o processamento dos documentos relacionados a emissão do diploma digital (Figura 01).

Ele tem acesso aos dados necessários para o processamento dos documentos por meio da base de dados de integração.

O Sistema de Gestão da instituição cliente fornece os dados necessários para geração do Diploma Digital.

O Conector é composto por um gateway na camada de persistência responsável pela comunicação com a base de integração da instituição cliente, um conjunto de daemons para processamento dos documentos e um API para comunicação.

O Conector possui três daemons de operação que são executados periodicamente e realizam as seguintes operações:

• Gerador de Documentos - Responsável pela geração dos documentos digitais baseado nos metadados adicionados na base de integração;

• Coletor de Assinatura - Responsável pelo processo de gestão de assinaturas digitais nos documentos digitais tratados. O Coletor de Assinatura é composto por serviço de gestão de assinaturas e demais softwares específicos necessários a geração de assinaturas digitais;

• Agente de Registro - Responsável pelo registro dos documentos assinados no Serviço de Registro, Autenticação e Preservação de Diplomas Digitais.

Todo o processo de tratamento do documentos é controlado internamente pelo Conector Local por meio de uma máquina de estados que indica a transição entre as operações e pontos de falha do processo.

Por meio da máquina de estados, o Sistema da instituição cliente pode acompanhar o processamento do documento.

Além disso, é possível controlar o tratamento do documento em suas diversas etapas a fim de contornar possíveis erros e realizar o reprocessamento quando for necessário, a partir de estados específicos.

O Conector Local é uma solução on premise que é instalada na infraestrutura da instituição cliente.

O tratamento dos documentos (acesso a base de integração, geração dos documentos e coleta de assinaturas) é feito localmente.

Os serviços de geração/inserção de carimbo de tempo, empacotamento de assinatura, registro e preservação de documentos é feito via serviço oferecido pela RNP (Figura 02).

Workflow de Processamento do Diploma Digital

O Workflow de processamento do diploma digital no contexto do Conector Local é realizado por meio dos três daemons que compõe a solução.

A instituição cliente, por meio da API de Comunicação, pode acompanhar o fluxo de processamento das documentos a partir da máquina de estados do Conector Local e integrar esse fluxo aos processos de gestão dos seus respectivos Sistemas Institucionais.

Na figura 03 todo o processo de tratamento do documento é ilustrado.

Para dar início ao processamento de um documento, o Sistema da instituição cliente deverá inserir via API nova entrada do documento que deseja tratar informando os respectivos metadados obrigatórios.

Cada documento possui um conjunto de metadados que deverá ser preenchido e indicado.

Uma vez inserido os dados, os daemons que compõe o Conector Local realizarão o tratamento, executando as ações de geração, gestão de assinaturas digitais, registro e preservação do documento.

O Agente de Registro pode realizar o processamento de um documento por vez ou de um grupo de documentos.

Quando trabalhando sobre grupo de documentos, o Agente de Registro aguarda para que todos os documentos daquela determinado grupo estejam com o processo de assinatura finalizado para então realizar o registro e preservação em lote da tupla de documentos.

Essa função permite o tratamento em um mesmo lote de documentos que estão relacionados.

O processo de geração do diploma digital envolve o tratamento de três documentos específicos, a saber: XML de Documentação Acadêmica , XML do Diploma Digital e Representação Visual do Diploma.

Os três documentos em questão possuem uma relação de dependência no processo de geração.

O XML da Documentação Acadêmica é o documento base que deve ser inicialmente gerado.

O XML do Diploma Digital é gerado em seguida, e por fim, a representação visual pode ser construída.

A Figura 04 ilustra a relação entre os documentos e os dados exigidos para seus respectivos processamentos

O Conector Local trata cada um dos documentos de forma separada, cabendo ao ERP da instituição indicar a geração do próximo documento após a finalização do processo de assinatura do documento anterior.

Para o processamento de cada documento, um conjunto de metadados devem ser passados.

Cada documento possui seu conjunto específico de metadados.

O ERP da instituição indica tais metadados (no formato JSON) e o código do tipo de documento que será processado para o Conector Local por meio da API de Comunicação. Desta forma, o documento indicado é gerado e passa para etapa de coleta de assinatura.

No processo de coleta de assinatura, os atores que possuem alçada para realizar a assinatura do documento, o fazem na quantidade, ordem e formato estabelecido na legislação e nota técnica. O processo de geração e empacotamento de assinatura segue a normatização ICP-Brasil.

Por se tratarem de documentos no formato XML, o Diploma Digital, a Documentação Acadêmica e O Histórico Escolar, possuem suas assinaturas processadas no formato Xades, além de utilizarem políticas de assinatura que permitam sua guarda de longo prazo. A Representação Visual dispensa coleta de assinaturas.

Caso os documentos estejam sendo processados em grupo, existe uma relação de dependência de tal forma que o Agente de Registro do Conector Local, somente realiza o processo de registro e preservação no serviço RAP após a finalização do tratamento (geração, coleta e empacotamento de assinatura) dos documentos associados ao grupo.

Uma vez finalizado o tratamento, o Agente de Registro realiza o registro e preservação em lote da tupla de documentos.

Nessa etapa, o conjunto de documentos é enviado para registro na Blockchain e posterior guarda no ambiente de preservação digital do serviço.

Os estados de processamento do documento podem ser acessados via rota específica.

À medida que o documento vai passando pelas diversas fases de tratamento, a tabela em questão é atualizada com o status.

Todo o controle do fluxo de processamento é feito por meio da atualização de estados dentro da base de integração.

Tanto estado atual de um documento quando histórico de estados passados podem ser acessados via API.

Os IDs de estados possíveis são indicados pelos seguintes códigos:

● Status padrão ○ 0 - Dados de processamento instanciados; ○ 1 - Documento preparado para geração; ○ 2 - Documento gerado; ○ 3 - Inicializando processamento de assinaturas; ○ 4 - Processo de assinatura iniciado; ○ 5 - Coletando Assinatura; ○ 6 - Documento Assinado; ○ 7 - Preparando processo de registro; ○ 8 - Registro iniciado; ○ 9 - Documento Processado ○ 10 - Documento válido ○ 11 - Suspenso ○ 12 - Inicializando Revogação ○ 13 - Revogando ○ 14 - Revogado

● Status Especiais ○ 11 - Documento suspenso ■ Deve ser informado o motivo da suspensão; ■ Podem existir múltiplas entradas desse campo para cada documento, mantendo um histórico de suspensões. ■ Pode ser utilizado para manter os registro de suspensão do Diploma Digital ( Nota Técnica No. 13/2019/DIFES/SESU/SESU/MEC, Seção 7.12 - Anulação do Diploma ). ○ 12 - Iniciando Revogação; ○ 13 - Processando Revogação ○ 14 - Documento Revogado; ■ Após revogado o documento não pode ter seu status alterado; ■ Deve ser informado o motivo da suspensão; ■ Pode ser utilizado para gerir o processo de anulação do Diploma Digital ( Nota Técnica No. 13/2019/DIFES/SESU/SESU/MEC, Seção 7.12 - Anulação do Diploma ).

● Status de Erro ○ 500 - Erro preparando geração do documento; ○ 501 - Erro gerando documento; ○ 502 - Erro inicializando processamento de assinaturas; ○ 503 - Erro finalizando processamento de assinaturas; ○ 504 - Erro Iniciando processo de registro; ○ 505 - Erro finalizando processo de registro; ○ 506 - Erro revogando documento;

O Anexo I da versão 1.04.1 da Instrução Normativa nº1 de 2020 do MEC estabeleceu a criação do Histórico Escolar (destacado da Documentação Acadêmica) possuindo três classificações:

Histórico Integral (Final) - é o histórico emitido quando da finalização da relação do discente com a IES, com validade jurídica, seja para emissão de diploma ou para transferência externa.

Esse histórico possui o documentType “3”, possui o docType "final_academic_transcript" e está disponível para emissão a partir da versão 0.16.0.

Histórico Parcial - é o histórico emitido a qualquer tempo da relação do discente com a IES com fins de comprovação jurídica do nível de integralização curricular.

Esse histórico possui o documentType “1”, possui o docType "partial_academic_transcript" e está disponível para emissão a partir da versão 0.17.0.

O Histórico Parcial pode ser emitido de maneira individual (sem a necessidade da emissão dos outros documentos do diploma digital) e possui um group_id próprio.

Histórico de Simples Conferência - é o histórico emitido a qualquer tempo da relação do discente com a IES para acompanhamento do nível de integralização curricular.

Atenção: Estes históricos não são alvo do normativo e podem ter padrão próprio de cada IES.

2. Pré-Instalação

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).

3. Atualização do Conector

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.

4. Preenchendo metadados e Iniciando uma Geração de uma Lista de Diplomas Anulados

Preencha os metadados JSON para geração do XML da Lista de Diplomas Anulados:

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. O campo groupId deve ter um valor próprio para o Histórico Escolar Parcial, já que se trata de um documento à parte.

ii. A seção data será usada para gerar o XML da Lista de Diplomas Anulados. Os dados solicitados na seção data foram extraídos da própria norma.

iii. O documento pode ser emitido passando os dados completos dos diplomas anulados ou informando o docId dos diplomas que foram anulados pela IES.

Nesse segundo modo, para que a Lista de Diploma Anulados seja gerada de maneira correta, os docId informados devem ser de documentos do tipo diploma, no status 14 (revogado), e que o motivo de revogação seja uma string contida no enumeration definido pelo XSD do MEC (e no JSON Schema) para esse campo.

iv. 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": "MotivoAnuacao",

"notes": "AnotacaoAnulacao"

}

b. Envie o documento para iniciar o seu processamento usando a rota POST /documents da API de Comunicação. Para o processamento de uma lista de diplomas anulados, o código do tipo é 8.

c. O processo de geração e registro pode ser acompanhado com as rotas GET /documents e GET /documents/{docId}/state

i. GET /documents - lista documentos e estados atuais.

1. Exemplo - Listando estado atual do documento com código.

ii. GET /documents/{docId}/state - Lista todos os estados de um documento.

1. Exemplo - listando estados do documento com código 2.

d. Quando o documento estiver no status 2, é possível visualizar a Lista de Diplomas Anulados. Para isso acesse a URL: <IP_do_Conector>:/documents/{docId}/view/ O XML da Lista de Diplomas Anulados será renderizado de forma amigável.

e. Se as informações estiverem corretas, deve-se autorizar o processamento do documento através da rota PATCH /documents/{docId}/authorization.

Após isso, o documento irá para o status 4.

f. Quando o documento estiver no status 4, realize a coleta das assinaturas do XML da Lista de Diplomas Anulados.

g. Após a coleta, a Lista de Diplomas Anulados irá para o status 10.

5. Preenchendo metadados e Iniciando uma Geração de Arquivo de Fiscalização da Registradora

1. Preencha os metadados JSON para geração do XML do Arquivo Fiscalização Registradora.

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. O campo groupId deve ter um valor próprio para o Histórico Escolar Parcial, já que se trata de um documento à parte.

ii. A seção data será usada para gerar o XML do Arquivo de Fiscalização Registradora. Os dados solicitados na seção data foram extraídos da própria norma.

iii. O documento pode ser emitido passando os dados completos dos diplomas registrados ou informando o docId dos diplomas que foram registrados pela IES.

Nesse segundo modo, para que o Arquivo de Fiscalização da Registradora seja gerado de maneira correta, os docId informados devem ser de documentos do tipo diploma e já emitido.

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 é 9.

c. O processo de geração e registro pode ser acompanhado com as rotas GET /documents e GET /documents/{docId}/state.

i. GET /documents - lista documentos e estados atuais.

1. Exemplo - Listando estado atual do documento com código.

ii. GET /documents/{docId}/state - Lista todos os estados de um documento.

1. Exemplo - listando estados do documento com código 2.

d. Quando o documento estiver no status 2, é possível visualizar o Arquivo de Fiscalização da Registradora. Para isso acesse a URL: <IP_do_Conector>:/documents/{docId}/view/ O XML do Arquivo de Fiscalização da Registradora será renderizado de forma amigável.

e. Se as informações estiverem corretas, deve-se autorizar o processamento do documento através da rota PATCH /documents/{docId}/authorization. Após isso, o documento irá para o status 4.

f. Quando o documento estiver no status 4, realize a coleta das assinaturas do XML do Arquivo de Fiscalização da Registradora.

g. Após a coleta, o Arquivo de Fiscalização da Registradora irá para o status 10.

6. Preenchendo metadados e Iniciando uma Geração de Arquivo de Fiscalização da Emissora

Preencha os metadados JSON para geração do XML do Arquivo Fiscalização Emissora.

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. O campo groupId deve ter um valor próprio para o Histórico Escolar Parcial, já que se trata de um documento à parte.

ii. A seção data será usada para gerar o XML do Arquivo de Fiscalização Registradora. Os dados solicitados na seção data foram extraídos da própria norma.

iii. O documento pode ser emitido passando os dados completos dos diplomas registrados ou informando o docId e dados complementares dos diplomas que foram registrados pela IES.

Nesse segundo modo, para que o Arquivo de Fiscalização da Emissora seja gerado de maneira correta, os docId informados devem ser de documentos do tipo diploma e já emitido.

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 é 10.

c. O processo de geração e registro pode ser acompanhado com as rotas GET /documents e GET /documents/{docId}/state.

i. GET /documents - lista documentos e estados atuais.

1. Exemplo - Listando estado atual do documento com código.

ii. GET /documents/{docId}/state - Lista todos os estados de um documento.

1. Exemplo - listando estados do documento com código 2.

d. Quando o documento estiver no status 2, é possível visualizar o Arquivo de Fiscalização da Emissora. Para isso acesse a URL: <IP_do_Conector>:/documents/{docId}/view/. O XML do Arquivo de Fiscalização da Emissora será renderizado de forma amigável.

e. Se as informações estiverem corretas, deve-se autorizar o processamento do documento através da rota PATCH /documents/{docId}/authorization. Após isso, o documento irá para o status 4.

f. Quando o documento estiver no status 4, realize a coleta das assinaturas do XML do Arquivo de Fiscalização da Emissora.

g. Após a coleta, o Arquivo de Fiscalização da Emissora irá para o status 10.

7. Preenchendo metadados e Iniciando uma Geração de Currículo Escolar

Preencha os metadados JSON para geração do XML do Currículo Escolar.

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. O campo groupId deve ter um valor próprio para o Currículo, já que se trata de um documento à parte.

ii. A seção data será usada para gerar o XML do Currículo Escolar. Os dados solicitados na seção data foram extraídos da própria norma.

b. Envie o documento para iniciar o seu processamento usando a rota POST /documents da API de Comunicação. Para o processamento de um Currículo Escolar, o código do tipo é 11.

c. O processo de geração e registro pode ser acompanhado com as rotas GET /documents e GET /documents/{docId}/state

i. GET /documents - lista documentos e estados atuais

1. Exemplo - Listando estado atual do documento com código.

ii. GET /documents/{docId}/state - Lista todos os estados de um documento

1. Exemplo - listando estados do documento com código 2.

d. Quando o documento estiver no status 2, é possível visualizar o Currículo Escolar. Para isso acesse a URL: <IP_do_Conector>:/documents/{docId}/view/. O XML do Currículo Escolar será renderizado de forma amigável.

e. Se as informações estiverem corretas, deve-se autorizar o processamento do documento através da rota PATCH /documents/{docId}/authorization. Após isso, o documento irá para o status 4.

f. Quando o documento estiver no status 4, realize a coleta das assinaturas do XML do Currículo Escolar.

Após a coleta, o Currículo Escolar irá para o status 10.

Preencha os metadados JSON para processamento do PDF gerado pela instituição da Representação Visual do Currículo Escolar.

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. O campo groupId deve ser o mesmo utilizado para gerar o XML do Currículo Escolarl. O Conector utiliza internamente esse campo para associar um conjunto de documentos relacionados a um diploma.

ii. A seção data será usada para indexar a Representação Visual do Currículo Escolar. O campo ReferenciaCurriculo deve ser preenchido com o valor do securityCode retornado pela rota GET /documents/{docId}/.

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 é 12.

c. O processo de geração e registro 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}/state - Lista estado atual de um documento.

d. O PDF da representação visual do currículo escolar não é assinado digitalmente.

e. A Representação Visual do Currículo Escolar deve ser enviada no formato de preservação PDF/A. Caso não seja enviada nesse formato, o Conector tentará converter. Se a conversão não tiver sucesso, o processo de geração do PDF deve ser alterado para atender esse requisito.

f. Após o processamento da Representação Visual do Currículo Escolar, esta é Registrada e Preservada na nuvem da RNP e irá para o status 10.

8. Documentação da API dos Arquivos Auxiliares

Toda a comunicação entre o ERP da instituição e o Conector Local é feita 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/. 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 openapi.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.

8.1 Validação dos dados JSON antes do início da geração

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.

9. Pós-Processamento

Após o registro dos documentos é possível realizar algumas ações sobre o mesmo, quais sejam:

1. 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. Para que um documento possa ser revogado, ele precisa estar no status 10 (Documento Válido) ou status 11 (Documento Suspenso).

b. Rota POST /documents /{docId} /revoke

3. Verificação de histórico de um documento.

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

10. Assinatura dos Documentos

Com o RAPSign configurado e instalado (ver documentação específica).

O processo de assinatura é semelhante aos Diplomas Digitais.

Depois que a instituição solicitar a habilitação da funcionalidade de emissão dos Arquivos Auxiliares, no RAPSign aparecerá um novo filtro para acesso à assinatura de documento deste tipo, conforme mostrado na imagem abaixo.

A configuração mínima de assinaturas para os Arquivos Auxiliares estão listadas a seguir:

Arquivo de Fiscalização da Emissora possui as as seguintes assinaturas:

1. eCNPJ [Certificado Institucional] Assina Documentação Acadêmica com assinatura institucional

Arquivo de Fiscalização da Registradora possui as as seguintes assinaturas:

1. eCNPJ [Certificado Institucional] Assina Documentação Acadêmica com assinatura institucional.

Lista de Diplomas Anulados possui as as seguintes assinaturas:

1. eCNPJ [Certificado Institucional] Assina a Lista de Diplomas Anulados com assinatura institucional

Currículo Escolar possui as as seguintes assinaturas:

1. eCPF Assina Currículo Escolar (opcional).

2. eCNPJ [Certificado Institucional] Assina Currículo Escolar com assinatura de arquivamento.

2. Pré-Instalação

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).

3. Atualização do Conector

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.

4. Preenchendo metadados e Iniciando uma Geração de Histórico Escolar Parcial

Preencha os metadados JSON para geração do XML do Histórico Escolar Parcial:

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. O campo groupId deve ter um valor próprio para o Histórico Escolar Parcial, já que se trata de um documento à parte.

ii. A seção data será usada para gerar o XML do Histórico Escolar Parcial. Os dados solicitados na seção data foram extraídos da própria norma.

b. Envie o documento para iniciar o seu processamento usando a rota POST /documents da API de Comunicação. Para o processamento de um histórico escolar parcial, o código do tipo é 1.

c. O processo de geração e registro pode ser acompanhado com as rotas GET /documents e GET /documents/{docId}/state

i. GET /documents - lista documentos e estados atuais.

1. Exemplo - Listando estado atual do documento com código.

ii. GET /documents/{docId}/state - Lista todos os estados de um documento.

1. Exemplo - listando estados do documento com código 2.

d. Quando o documento estiver no status 4, realize a coleta das assinaturas do XML do Histórico Escolar Parcial.

Após a coleta o Histórico irá para o status 10.

Atenção: Os documentos do tipo Histórico Escolar Parcial não são armazenados no serviço de Preservação da RNP. Os arquivos XMLs ficam armazenados apenas localmente em sistema de arquivo.

4.1. Validação dos dados JSON antes do início da geração

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.

5. Documentação da API de Histórico Escolar Parcial

Toda a comunicação entre o ERP da instituição e o Conector Local é feita 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/. A porta padrão para a API de 5 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 openapi.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.

6. Pós-Processamento

Após o registro dos documentos é possível realizar algumas ações sobre o mesmo, quais sejam:

1. 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 re emissão.

a. Para que um documento possa ser revogado, ele precisa estar no status 10 (Documento Válido) ou status 11 (Documento Suspenso).

b. Rota POST /documents /{docId} /revoke

3. Verificação de histórico de um documento

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

7. Assinatura dos Documentos

Com o RAPSign configurado e instalado (ver documentação específica).

O processo de assinatura é semelhante aos Diplomas Digitais.

Depois que a instituição solicitar a habilitação da funcionalidade de emissão de Histórico Escolar Parcial, no RAPSign aparecerá um novo filtro para acesso à assinatura de documento deste tipo, conforme mostrado na imagem abaixo.

A configuração mínima de assinaturas para Histórico Escolar Parcial contém a seguinte:

eCNPJ (Certificado Institucional) Assina a raiz do Histórico com assinatura institucional.

Esse documento tem como objetivo descrever de forma resumida os passos para emissão e assinatura dos Arquivos Auxiliares do Diploma Digital.

O Anexo I da versão 1.04.1 da Instrução Normativa nº1 de 2020 do MEC estabeleceu a criação dos seguintes tipos de documentos:

Lista de Diplomas Anulados - é um documento a ser criado pela IES Registradora a fim de expor a anulação de diplomas digitais em seus livros de registro e permitir a validação automática de tal fato através dos verificadores de conformidade de diplomas e dos sítios únicos de cada diploma.

Esse histórico possui o documentType “8”, possui o docType "degree_revocation_list”.

Arquivo de Fiscalização - este arquivo somente deverá ser gerado por solicitação expressa do MEC e em atendimento aos procedimentos necessários ao MEC para o cumprimento de suas prerrogativas. A fiscalização por parte do MEC pode se dar em dois contextos diferentes.

Arquivo de Fiscalização Registradora - outro contexto é o de fiscalização de livros de registro, o que acontece no âmbito de uma IES Registradora.

Esse histórico possui o documentType “9”, possui o docType "audit_file_registry".

Arquivo de Fiscalização Emissora - no contexto da uma IES Emissora que pode ter seu acervo relativo ao diploma digital sendo averiguado.

Esse histórico possui o documentType “10”, possui o docType "audit_file_issuer".

Os três tipos de documentos apresentados, podem ser emitidos de maneira individual (sem a necessidade da emissão dos outros documentos do diploma digital) e possui um group_id próprio.

1. Pós-Processamento

Após o registro dos documentos é possível realizar algumas ações sobre o mesmo, quais sejam:

1. 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 re-emissão.

a. Geralmente um diploma revogado deve ter todos os seus arquivos revogados (XML da Documentação Acadêmica, XML do Histórico Escolar Final ,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.

Rotas:

POST /documents/{docId}/restart-processing

POST /documents/{docId}/retry-generation

POST /documents/{docId}/retry-signatur

POST /documents/{docId}/retry-registration

POST /documents/{docId}/retry-revocation

5. Autenticar um documento dentro do Serviço de Diploma

a. É possível validar a estrutura, registro e preservação de um documento passando o arquivo para o Serviço de Diploma; b. Rota POST /documents/authenticate

6. Acessar o recibo de registro no Serviço de Diplomas da RNP

a. Rota GET /documents/{docId}/receipt

7. Baixar algum dos arquivos gerados durante o processamento dos documentos do diploma

a. É possível acessar o arquivo gerado ou o arquivo final assinado; b. Rota GET /documents/{docId}/files

Informações adicionais sobre o uso das Rotas da API, fluxos de processamento e dicas para preenchimento dos metadados de geração podem ser lidas na documentação acessória enviada.

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);

Pode ser necessário executar novamente um conjunto de passos para um determinado documento, por necessidade ou por ocorrência de uma situação de erro.

Para tanto, o controle do fluxo pode ser feito via API de comunicação. Basicamente, os cenários em que pode ser necessário aplicar uma estratégia de retry são:

Reiniciar completamente o processamento do arquivo a. Esse procedimento atualiza todo o contexto de processamento do documento, inclusive os responsáveis pela assinatura, caso uma nova configuração de responsáveis tenha sido criada para o grupo de documentos;

Reiniciar o processo de geração b. O documento retorna ao estado de início do processo de geração;

Reiniciar o processo de coleta de assinaturas c. O documento retorna ao estado de pronto para coleta de assinaturas;

Reiniciar o processo de finalização das assinaturas (OBS: o reinício a partir daqui não exige a coleta novamente das assinaturas ) d. A montagem do documento final é refeita

Reiniciar o processo de registro no serviço de preservação e. Deve ser usado nos casos em que houve falha no registro. Geralmente devido a entrada em algum código de erro no processo de registro;

Suspender um documento já processado e válido f. Suspende temporariamente um documento. O motivo deve ser informado;

Reativar um documento suspenso g. Reativa um documento suspenso. O motivo deve ser informado;

Iniciar o processo de revogação de um documento h. Processo irreversível. No tocante ao Diploma Digital, para emissão de um novo diploma para a mesma pessoa, todo o processo de emissão deverá ser reiniciado com um novo id de documento e no que couber, nova documentação acadêmica.

OBSERVAÇÃO 1: Como os documentos referentes a emissão do Diploma Digital dependem um do outro recomenda-se utilizar as funções de retry sempre em um documento base e em todos os documentos que dependem dele. Por exemplo, caso se deseje reiniciar o processo de emissão do XML da Documentação Acadêmica, deve-se também, após seu processamento, reiniciar o processo de emissão do Diploma Digital e, por conseguinte, o processo de conversão da representação visual para o formato PDF/A.

OBSERVAÇÃO 2: Recomenda-se não utilizar as rotinas de retry com documentos que já se encontram com status válido, suspenso ou revogado (10,11 e 13, respectivamente).

OBSERVAÇÃO 3: Nos casos que se deseje registrar novamente documento já válido, deve-se revogá-lo e iniciar um novo processo.

Partindo da premissa que o novo ambiente(VM) na nuvem já esteja configurado com Docker e Docker Compose, siga as regras de acesso para acesso SSH para que os arquivos possam ser copiados.

Certifique-se de ter backups adequados de todos os dados e configurações antes da migração.

Subir o docker-compose na nova VM:

Certifique-se de que você tenha o arquivo do diploma docker-compose.yml na nova VM.

Obs: É necessário que seja a mesma versão de ambos serviços que rodam atualmente na sua infraestrutura.

docker-compose –f docker-compose.yml up -d

Migrar os dados dos volumes:

Execute os passos para exportar e importar os volumes.

# Exportar volumes na VM antiga

docker run --rm -v postgresql-data:/volume -v $(pwd):/backup ubuntu tar cvf /backup/postgresql-data.tar /volume

docker run --rm -v rapconector-data:/volume -v $(pwd):/backup ubuntu tar cvf /backup/rapconector data.tar /volume

# Transferir os arquivos para a nova VM (executado localmente)

scp postgresql-data.tar user@nova-vm:/path/to/backup

scp rapconector-data.tar user@nova-vm:/path/to/backup

# Importar volumes na nova VM

docker run --rm -v postgresql-data:/volume -v /path/to/backup:/backup ubuntu bash -c "cd /volume && tar xvf /backup/postgresql-data.tar --strip 1"

docker run --rm -v rapconector-data:/volume -v /path/to/backup:/backup ubuntu bash -c "cd /volume && tar xvf /backup/rapconector-data.tar --strip 1"

Verificar variáveis de ambiente e configurações:

Certifique-se de que todas as variáveis de ambiente e configurações no docker-compose.yml estão corretas e compatíveis com a nova VM.

Legenda dos comandos:

Comandos para Exportar Volumes

1. Exportar volumes na VM antiga:

docker run --rm -v postgresql-data:/volume -v $(pwd):/backup ubuntu tar cvf /backup/postgresql-data.tar /volume

Explicação:

● docker run --rm: Cria e executa um novo container temporário que é removido após a execução.

● -v postgresql-data:/volume: Monta o volume postgresql-data do Docker no caminho /volume dentro do container.

● -v $(pwd):/backup: Monta o diretório atual do host (diretório de trabalho atual) no caminho /backup dentro do container.

● ubuntu: Usa a imagem ubuntu para criar o container.

● tar cvf /backup/postgresql-data.tar /volume: Executa o comando tar dentro do container para criar um arquivo tar (postgresql-data.tar) contendo o conteúdo do volume /volume.

Este comando cria um arquivo tar com os dados do volume postgresql-data.

1. Transferir os arquivos para a nova VM (executado localmente):

scp postgresql-data.tar user@nova-vm:/path/to/backup

scp rapconector-data.tar user@nova-vm:/path/to/backup

Explicação:

● scp: Comando de cópia segura que transfere arquivos entre hosts em uma rede.

● postgresql-data.tar: Arquivo a ser transferido.

● user@new-vm:/path/to/backup: Destino na nova VM onde o arquivo será copiado. Substitua user pelo nome do usuário e new-vm pelo endereço da nova VM.

Comandos para Importar Volumes

1. Importar volumes na nova VM:

docker run --rm -v postgresql-data:/volume -v /path/to/backup:/backup ubuntu bash -c "cd /volume && tar xvf /backup/postgresql-data.tar --strip 1"

Explicação:

● docker run --rm: Cria e executa um novo container temporário que é removido após a execução.

● -v postgresql-data:/volume: Monta o volume postgresql-data do Docker no caminho /volume dentro do container.

● -v /path/to/backup:/backup: Monta o diretório onde o arquivo tar foi transferido no caminho /backup dentro do container.

● ubuntu bash -c "cd /volume && tar xvf /backup/postgresql-data.tar --strip 1": Usa a imagem ubuntu para criar o container e executa o comando tar dentro do container para extrair o conteúdo do arquivo tar no volume /volume.

Este comando extrai o conteúdo do arquivo tar no volume postgresql-data.

Após o registro dos documentos é possível realizar algumas ações sobre o mesmo, quais sejam:

1. 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

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.

1. Pré-Instalação

1.1. Solicite as credenciais para uso do serviço

a. Credenciais para uso do RAP: i. Login; ii. Senha; iii. Client ID - ID que identifica unicamente cada instituição; iv. URL do ambiente de homologação. b. Credenciais para acesso ao registro de imagens privados do Serviço: i. Login; ii. Senha;

1.2. Cadastro e Configuração de Certificados Digitais

a. Envie os certificados com chave pública que serão utilizados no teste para RNP: i. Podem ser exportados a partir dos containers A1 (arquivo.pfx) ou A3 (token criptográfico) para o formato .cer via ferramenta RAPSign; ii. Caso ainda não tenha certificado, solicite à RNP certificados exemplares. Nesse caso, eles já serão cadastrados no sistema antes do envio; iii. Recomendamos o uso de pelo menos dois certificados para simular o processo. Um para simular a pessoa jurídica da instituição e outro para simular uma pessoa física;

1.3. Requisitos para Infraestrutura recomendada para instalação do Conector

Serão executados, nesse ambiente, um par de imagens Docker (uma com o conector e outra com o banco de dados) além de um volume para armazenar o banco. A configuração mínima é uma Máquina virtual básica com uma CPU e 2Gb de RAM. É recomendado 2 vCPU e 4 Gb de RAM para um processamento mais fluido.

Apesar do Docker virtualizar também para outros sistemas operacionais é fortemente recomendado que a imagem seja utilizada no Sistema Operacional Linux, mais especificamente nas distribuições Ubuntu ou Debian. Isso é necessário para evitar problemas de configurações que diferem de um sistema para outro, principalmente, configurações de rede.

1.4. Requisitos para instalação do Container

a. Para o deploy deste projeto, é necessário ter instalado algumas ferramentas de conteinerização: i. Para instalação do Docker Engine execute os seguintes comandos:

$ curl -fsSL https://get.docker.com -o get-docker.sh

$ sudo sh get-docker.sh

ii. Para instalação do Docker Compose execute os seguintes comandos:

$ sudo curl -L
"https://github.com/docker/compose/releases/download/1.25.3/docker-compose-
$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

$ sudo chmod +x /usr/local/bin/docker-compose

2. Instalação

2.1 Edite o arquivo docker-compose.api.yml**

a. Adicione as credenciais para acesso ao Serviço de Diplomas: i. Login (RAP_API_USER_EMAIL); ii. Senha (RAP_API_USER_PASS); iii. Client ID (INSTITUTION_ID). iv. *As variáveis de configuração do RAP Sign WEB também serão configuradas no mesmo arquivo docker-compose. Verifique manual próprio da aplicação

b. Realize login no registro privado de imagens do ambiente de homologação:

$ docker login https://homolog-diploma.rnp.br/

c. Execute o script do docker-compose para: i. Download da imagem atualizada do Conector; ii. Configuração automática do banco (criação e execução dos scripts para migração de tabelas); iii. Inicialização dos daemons de processamento de documentos e APIs de Comunicação;

$ docker-compose -f docker-compose.api.yml up

iv. Opcionalmente efetue logoff do serviço de registro de imagens;

$ docker logout https://homolog-diploma.rnp.br/

Obs.: Caso o conector na primeira execução apresentar problema de conexão com o banco, reinicie o mesmo.

Vídeo demonstrativo da Instalação e Configuração dos Componentes Locais:

3. Procedimentos de Instalação

Procedimentos para instalação e integração via API de Comunicação

1. Acessar o serviço de registro de imagens (URL temporária do ambiente de homologação. A URL para configuração do ambiente de produção é enviada para instituição junto com as credenciais do ambiente de produção no início da operação do serviço).

2. Inserir credenciais para acesso ao serviço registro privado de imagens docker do Conector local;

3. Instalar o docker-compose4;

4. Configurar as variáveis de ambiente no arquivo docker-compose.api.yml para acesso ao banco de dados, serviço RAP, bem como variáveis adicionais (ver Seção 5);

5. Iniciar o Conector local. É possível indicar a opção -d para que o serviço rode em background;

6. (Opcional) Após a configuração e execução do docker-compose é possível remover as informações de login ao repositório privado de imagens com o comando. Caso seja necessário no futuro atualizar a imagem do Conector, o processo de login deverá ser feito novamente.

3 https://www.iti.gov.br/legislacao/documentos-principais

4 https://docs.docker.com/compose/install/

OBSERVAÇÃO: Na primeira execução, as ações de configuração do banco de dados serão executadas pelo próprio Conector, sendo necessário apenas configurar as informações referentes ao nome do banco e credenciais que serão usados. O banco de dados utilizado é o PostgresSQL.

4. Atualização do Conector

Para verificar a existência de atualizações no Conector deve-se executar o seguinte comando utilizando o docker-compose*:

$ docker login https://homolog-diploma.rnp.br/
$ docker-compose -f docker-compose.api.yml pull
$ docker logout https://homolog-diploma.rnp.br/

Caso exista a versão mais recente do Conector, esta será baixada automaticamente. Após isso, basta reiniciar os containers.

$ docker-compose -f docker-compose.api.yml restart

Vide Release Note do Conector Local.

4.1 Como localizar o log completo do conector.

Para localizar o log completo do conector deve-se executar o seguinte comando:

• sudo docker cp <container_id>:/var/log

5. Procedimentos de Configuração

O Conector Local possui algumas variáveis configuráveis.

Essas variáveis são passadas para container do Conector Local por meio de arquivo de configuração docker-compose.api.yml.

A descrição de cada variável de ambiente é dada no próprio arquivo.

6. Documentação da API

Toda a comunicação entre o Sistema 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://<IP-DO-CONECTOR>:<PORTAS>/docs. 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 openapi.json**

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 Postman:

Vide arquivo Conector API Environment.postman_environment.json**

Vide arquivo RAP Conector.postman_collection.json**

**Os arquivos referenciados são disponibilizados para as Instituições que aderiram ao Serviço e que estão em processo de implantação.

7. Procedimentos para Operação

Inicialização do Processo de Gestão do Diploma

Para o início do processo de geração as seguintes ações devem ser realizadas:

● XML da Documentação Acadêmica:

Montagem dos metadados a partir do preenchimento do JSON específico;

Inserção do JSON no Conector via API;

Indicação do código 4 para tratamento de Documentação Acadêmica;

● XML do Histórico Escolar Final:

Montagem dos metadados a partir do preenchimento do JSON específico;

Inserção do JSON no Conector via API;

Indicação do código 3 para tratamento do Histórico Escolar Final;

● XML do Diploma Digital:

Montagem dos metadados a partir do preenchimento do JSON específico;

Inserção do JSON no Conector via API;

Indicação do código 2 para tratamento do Diploma Digital;

● Tratamento da versão PDF/A da Representação Visual:

Montagem dos metadados a partir do preenchimento do JSON específico;

Inserção do JSON no Conector via API;

Indicação do código 5 para tratamento da Representação Visual;

Envio do arquivo no formato PDF/A que será processado;

O processo de tratamento da Representação Visual converte verifica se a representação visual está no formato de preservação PDF/A. Caso não esteja, o Conector tentará convertê-lo. Caso a conversão seja bem sucedida, o processo de registro do referido documento no Serviço RAP será realizado.

No presente momento todas as demais ações necessárias para geração da representação visual do diploma (layout e aposição de estruturas visuais) são de responsabilidade da instituição;

7.1 Ordem de Processamento

Para o caso dos documentos associados ao Diploma Digital, uma vez que esses dados possuem interdependência, os documentos devem ser processados na seguinte ordem:

XML da Documentação Acadêmica;

a. Geração, Assinatura

XML do Histórico Escolar Final;

a. Geração, Assinatura

XML do Diploma Digital;

a. Geração, Assinatura

PDF da Representação Visual (assinatura digital é dispensada);

a. Geração

Vale reforçar, que um documento subsequente, só deve ser enviado para processamento após a finalização completa do anterior, ou seja, após concluída a fase de registro.

8. Segurança e Estratégias de Backup

8.1 Autenticação na API do Conector com token JWT

No arquivo docker-compose existe uma flag RAP_USE_JWT_AUTHORIZATION que permite ativar a obrigatoriedade de autenticação com tokens JWT para uso das rotas do Conector.

O token pode ser obtido através da rota POST /users/auth e as credenciais são as mesmas que a instituição usa para configurar o Conector. O token tem duração de 15 minutos, mas é recomendado fazer o gerenciamento da expiração através da variável "exp" do token JWT decodificado (https://jwt.io/). Para atualização do token existe uma rota denominada POST /users/auth/refresh que permite a aquisição de um novo token JWT a partir do envio do refresh token.

8.2 Arquitetura e Estratégias de Firewall

A partir da versão 0.3.7 do RAP Sign WEB houve uma alteração da arquitetura dos componentes locais do serviço. O RAP Sign WEB possui agora um componente de front-end e um componente de back-end. O componente de back-end é o que de fato se comunica com a API do conector. Com essa arquitetura é possível isolar o conector na infraestrutura da instituição, sem a necessidade de expor suas rotas para acesso público.

A única aplicação que precisa ficar pública é o RAP Sign Web. Desta forma, recomenda-se limitar o acesso da API conector apenas para a aplicação RAP Sign Web e para as aplicações internas da instituição como forma de aumentar a segurança sobre a solução.

8.3 Estratégias de Backup

Para garantir a consistência, histórico dos documentos e funcionamento correto do serviço é necessário manter o banco de dados de integração do Conector íntegro. Sendo assim, é recomendado que as instituições utilizem estratégias de backup regulares para esse banco de integração.

Abaixo um exemplo de comando que pode ser utilizado para realizar o backup do banco de dados.

Recomenda-se também trabalhar com uma estratégia de backup do volume onde os arquivos do relacionados aos arquivos da documentação acadêmica, diplomas e representação visual se encontram. Para tanto recomenda-se o uso de redundância e sincronização periódica dos arquivos. É preciso observar a manutenção da coerência dos paths dos arquivos a partir do diretório base para que o Conector consiga acessar de forma correta todos os arquivos em caso de uma restauração de arquivos seja necessária.

Com relação às políticas e frequências de backup de banco e volume de arquivos, as instituições devem observar as melhores práticas para esse tipo de ação e aplicar/desenvolver estratégias nesse sentido que se encaixe aos requisitos de segurança trabalhados na instituição.

8.4 Execução dos serviços Docker

Recomenda-se apenas a execução de uma cópia do serviço Conector, dada a forma como os daemons internos trabalham. A execução de múltiplas cópias da aplicação pode gerar problemas de inconsistência dos dados.

Os serviços descritos no docker-compose não possuem mecanismo de reinicialização automática. Caso a máquina host seja reiniciada, estes devem ser manualmente reiniciados também. É possível, contudo, que a instituição configure via docker-compose políticas de reinicialização.

Conector v0.24.11

Aderente ao XSD V1.05 do MEC

29/10/2024

Atenção:

Atenção:

1. Quando houver necessidade de uso do caractere ‘$’ nas variáveis (como senhas) do Docker-compose, deve-se usar em vez de $ no arquivo docker-compose.yml. O impede que o Docker Compose interprete o valor como uma variável de ambiente, evitando erros de interpolação.

2. A partir da versão 0.4.0 do RAPSign WEB, é necessário que a versão do Conector seja superior ou igual a 0.24.5, pois é a versão compatível com as funcionalidades de contagem de quantidade de assinaturas em cada status de assinatura e contagem de quantidade de assinaturas em cada tipo de documento.

3. A partir da versão 0.23.0 do Conector, foi permitida a inserção de mais de um documento do mesmo tipo (exceto a documentação acadêmica) e com com Código de Segurança (context_id) no mesmo grupo de documento (groupId) desde que exista apenas um documento status válido e os demais no status revogado. Na prática, isso permite que documentos possam ser revogados sem ser deletados mesmo que os novos documentos não gerem um novo registro (ou seja, um novo código de segurança).

4. A partir da versão 0.23.0 do Conector, foi implementado a emissão de Histórico Escolar Final de maneira independente (avulso). Para isso deve ser usado o documento docType 1 e a tag HistoricoEscolarFinal.

5. É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.

6. 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.

Adicionado

● Listagem de tarefas em execução na rota de monitoramento de saúde do serviço.

● Contagemdenúmero de assinaturas pendentes no RAPSign (versão 0.4.1).

● RotaPUTpara autorizar um documento pelo seu docId.

● Rotapara listagem de um documento através do yourNumber associado a ele.

● Hookdenotificação para informar atualizações de estados de documentos. (ver seção 7.6 do documento Integração- Serviço Diploma Digital).

Corrigido

● Suporte ao uso de caracteres especiais em senha no banco de dados.

● Consumoexcessivo de memória durante a geração de documentos.

● Geração de Documentação Acadêmica Externa em lote.

● Geração do Currículo Escolar Digital com tag DadosCursoNSF.

● Otimização na contagem de números de assinaturas.

● Contagemdenúmeros de assinaturas institucionais pendentes.

● Finalização de assinatura com assinador substituto.

● Requisição de atualização de documento pelo Swagger.

● Validação de JSON do Diploma Digital para o campo NomeSocial.

● Lentidão ao gerar Documentação Acadêmica Externa com arquivo XML grande.

● Processamento da tag Signature durante a geração do Diploma Digital Externo.

● Remoçãodearquivos e diretórios inexistentes na rota de deletar documentos.

● Geração einicialização de assinatura de arquivos grandes.

● Falta de informações sobre erros de validação de documentos no validador do MEC.

● Paginação da rota de listagem de grupos.

Observações:

Obs1.: As 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.

Obs2.: 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.

Obs3.: 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).

Obs4.: 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.

Obs5.: 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.

Obs6.: 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.

Obs7.: 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”.

Obs8.: Os documentos anexos à Documentação Acadêmica, mesmo os que sejam assinados digitalmente, devem estar no formato PDF/A.

Conector v0.24.9

Aderente ao XSD V1.05 do MEC

26/08/2024

Atenção:

1. A partir da versão 0.24.0 do RAPSign WEB, é necessário que a versão do Conector seja superior ou igual a 0.24.5, pois é a versão compatível com as funcionalidades de contagem de quantidade de assinaturas em cada status de assinatura e contagem de quantidade de assinaturas em cada tipo de documento.

2. A partir da versão 0.23.0 do Conector, foi permitida a inserção de mais de um documento do mesmo tipo (exceto a documentação acadêmica) e com com Código de Segurança (context_id) no mesmo grupo de documento (groupId) desde que exista apenas um documento status válido e os demais no status revogado. Na prática, isso permite que documentos possam ser revogados sem ser deletados mesmo que os novos documentos não gerem um novo registro (ou seja, um novo código de segurança).

3. A partir da versão 0.23.0 do Conector, foi implementado a emissão de Histórico Escolar Final de maneira independente (avulso). Para isso deve ser usado o documento docType 1 e a tag HistoricoEscolarFinal.

4. É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.

5. 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.

Adicionado

● Contagem de número de assinaturas pendentes no RAPSign (versão 0.4.1).

● Rota PUT para autorizar um documento pelo seu docId.

● Rota para listagem de um documento através do yourNumber associado a ele.

● Hook de notificação para informar atualizações de estados de documentos. (ver seção 7.6 do documento Integração - Serviço Diploma Digital).

Corrigido

● Geração de Documentação Acadêmica Externa em lote.

● Geração do Currículo Escolar Digital com tag DadosCursoNSF.

● Otimização na contagem de números de assinaturas.

● Contagem de números de assinaturas institucionais pendentes.

● Finalização de assinatura com assinador substituto.

● Requisição de atualização de documento pelo Swagger.

● Validação de JSON do Diploma Digital para o campo NomeSocial.

● Lentidão ao gerar Documentação Acadêmica Externa com arquivo XML grande.

● Processamento da tag Signature durante a geração do Diploma Digital Externo.

● Remoção de arquivos e diretórios inexistentes na rota de deletar documentos.

● Geração e inicialização de assinatura de arquivos grandes.

● Falta de informações sobre erros de validação de documentos no validador do MEC.

● Paginação da rota de listagem de grupos.

Observações:

Obs1.: As 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.

Obs2.: 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.

Obs3.: 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).

Obs4.: 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.

Obs5.: 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.

Obs6.: 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.

Obs7.: 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”.

Obs8.: Os documentos anexos à Documentação Acadêmica, mesmo os que sejam assinados digitalmente, devem estar no formato PDF/A.

Conector v0.24.5

Aderente ao XSD V1.05 do MEC

25/07/2024

Atenção:

1. A partir da versão 0.24.0 do RAPSign WEB, é necessário que a versão do Conector seja superior ou igual a 0.24.5, pois é a versão compatível com as funcionalidades de contagem de quantidade de assinaturas em cada status de assinatura e contagem de quantidade de assinaturas em cada tipo de documento.

2. A partir da versão 0.23.0 do Conector, foi permitida a inserção de mais de um documento do mesmo tipo (exceto a documentação acadêmica) e com com Código de Segurança (context_id) no mesmo grupo de documento (groupId) desde que exista apenas um documento status válido e os demais no status revogado. Na prática, isso permite que documentos possam ser revogados sem ser deletados mesmo que os novos documentos não gerem um novo registro (ou seja, um novo código de segurança).

3. A partir da versão 0.23.0 do Conector, foi implementado a emissão de Histórico Escolar Final de maneira independente (avulso). Para isso deve ser usado o documento docType 1 e a tag HistoricoEscolarFinal.

4. É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.

5. 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.

Adicionado

● Contagem de número de assinaturas pendentes no RAPSign (versão 0.4.0).

● Rota PUT para autorizar um documento pelo seu docId.

● Rota para listagem de um documento através do yourNumber associado a ele.

● Hook de notificação para informar atualizações de estados de documentos. (ver seção 7.6 do documento Integração - Serviço Diploma Digital).

Corrigido

● Requisição de atualização de documento pelo Swagger.

● Validação de JSON do Diploma Digital para o campo NomeSocial.

● Lentidão ao gerar Documentação Acadêmica Externa com arquivo XML grande.

● Processamento da tag Signature durante a geração do Diploma Digital Externo.

● Remoção de arquivos e diretórios inexistentes na rota de deletar documentos.

● Geração e inicialização de assinatura de arquivos grandes.

● Falta de informações sobre erros de validação de documentos no validador do MEC.

● Paginação da rota de listagem de grupos.

Observações:

Obs1.: As 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.

Obs2.: 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.

Obs3.: 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).

Obs4.: 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.

Obs5.: 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.

Obs6.: 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.

Obs7.: 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”.

Obs8.: Os documentos anexos à Documentação Acadêmica, mesmo os que sejam assinados digitalmente, devem estar no formato PDF/A.

Conector v0.23.7

Aderente ao XSD V1.05 do MEC

02/05/2024

Atenção:

1. A partir da versão 0.23.0 do Conector, foi permitida a inserção de mais de um documento do mesmo tipo (exceto a documentação acadêmica) e com com Código de Segunda (context_id) no mesmo grupo de documento (groupId) desde que exista apenas um documento status válido e os demais no status revogado. Na prática, isso permite que documentos possam ser revogados sem ser deletados mesmo que os novos documentos não gerem um novo registro (ou seja, um novo código de segurança).

2. A partir da versão 0.23.0 do Conector, foi implementado a emissão de Histórico Escolar Final de maneira independente (avulso). Para isso deve ser usado o documento docType 1 e a tag HistoricoEscolarFinal.

3. É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.

4. 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.

Adicionado

● Cursos de assinadores na rota para listagem de configurações de assinatura de documentos.

● Rota para listagem de configurações de assinatura de documentos.

● Recuperação automática de arquivos preservados ausentes no armazenamento local.

● Data de inicialização de assinatura na resposta da rota de busca de estado do documento.

● Suporte a Históricos escolares avulsos.

● Versões do mesmo documento na resposta da rota de busca de documento por id.

Modificado

● Lógica de inserção de documentos em grupos para permitir códigos de segurança idênticos por tipo de documento.

Corrigido

● Remoção de arquivos e diretórios inexistentes na rota de deletar documentos.

● Geração e inicialização de assinatura de arquivos grandes.

● Falta de informações sobre erros de validação de documentos.

● Paginação da rota de listagem de grupos.

Observações:

Obs1.: As 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.

Obs2.: 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.

Obs3.: 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).

Obs4.: 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.

Obs5.: 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.

Obs6.: 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.

Obs7.: 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”.

Obs8.: Os documentos anexos à Documentação Acadêmica, mesmo os que sejam assinados digitalmente, devem estar no formato PDF/A.

Conector v0.23.3

Aderente ao XSD V1.05 do MEC

05/04/2024

Atenção:

1. A partir da versão 0.23.0 do Conector, foi permitida a inserção de mais de um documento do mesmo tipo (exceto a documentação acadêmica) e com com Código de Segunda (context_id) no mesmo grupo de documento (groupId) desde que exista apenas um documento status válido e os demais no status revogado. Na prática, isso permite que documentos possam ser revogados sem ser deletados mesmo que os novos documentos não gerem um novo registro (ou seja, um novo código de segurança).

2. A partir da versão 0.23.0 do Conector, foi implementado a emissão de Histórico Escolar Final de maneira independente (avulso). Para isso deve ser usado o documento docType 1 e a tag HistoricoEscolarFinal.

3. É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.

4. 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.

Adicionado

● Cursos de assinadores na rota para listagem de configurações de assinatura de documentos.

● Rota para listagem de configurações de assinatura de documentos.

● Recuperação automática de arquivos preservados ausentes no armazenamento local.

● Data de inicialização de assinatura na resposta da rota de busca de estado do documento.

● Suporte a Históricos escolares avulsos.

● Versões do mesmo documento na resposta da rota de busca de documento por id.

Modificado

● Lógica de inserção de documentos em grupos para permitir códigos de segurança idênticos por tipo de documento.

Corrigido

● Inconsistência na validação de esquema JSON para os campos RG e OutroDocumentoIdentificacao do Histórico Escolar Parcial.

● Falha no processo de registro de representações visuais.

● Inconsistência nos esquemas JSONs de DadosCurso, DadosIesEmissora e DadosDiplomado.

● Tempo de acesso a arquivos de anexos na rota protegida de visualização de documentos.

● Acesso a arquivos de anexos na rota protegida de visualização de documentos.

● Precisão do cálculo do tempo de expiração de refreshTokens JWT.

● Esquema JSON TDadosDiplomadoPorDecisaoJudicial.

Observações:

Obs.1: As 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.

Obs2.: 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.

Obs3.: 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).

Obs4.: 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.

Obs5.: 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.

Obs6.: 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.

Obs7.: 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”.

Obs8.: Os documentos anexos à Documentação Acadêmica, mesmo os que sejam assinados digitalmente, devem estar no formato PDF/A.

Conector v0.23.2

Aderente ao XSD V1.05 do MEC

14/02/2024

Atenção:

1. A partir da versão 0.23.0 do Conector, foi permitida a inserção de mais de um documento do mesmo tipo (exceto a documentação acadêmica) e com com Código de Segunda (context_id) no mesmo grupo de documento (groupId) desde que exista apenas um documento status válido e os demais no status revogado. Na prática, isso permite que documentos possam ser revogados sem ser deletados mesmo que os novos documentos não gerem um novo registro (ou seja, um novo código de segurança).

2. A partir da versão 0.23.0 do Conector, foi implementado a emissão de Histórico Escolar Final de maneira independente (avulso). Para isso deve ser usado o documento docType 1 e a tag HistoricoEscolarFinal.

3. É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.

4. 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.

Adicionado

● Cursos de assinadores na rota para listagem de configurações de assinatura de documentos.

● Rota para listagem de configurações de assinatura de documentos.

● Recuperação automática de arquivos preservados ausentes no armazenamento local.

● Data de inicialização de assinatura na resposta da rota de busca de estado do documento.

● Suporte a Históricos escolares avulsos.

● Versões do mesmo documento na resposta da rota de busca de documento por id.

Modificado

● Lógica de inserção de documentos em grupos para permitir códigos de segurança idênticos por tipo de documento.

Corrigido

● Inconsistência nos esquemas JSONs de DadosCurso, DadosIesEmissora e DadosDiplomado.

● Tempo de acesso a arquivos de anexos na rota protegida de visualização de documentos.

● Acesso a arquivos de anexos na rota protegida de visualização de documentos.

● Precisão do cálculo do tempo de expiração de refreshTokens JWT.

● Esquema JSON TDadosDiplomadoPorDecisaoJudicial.

Observações:

Obs.: As 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.

Obs2.: 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.

Obs3.: 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).

Obs4.: 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.

Obs5.: 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.

Obs6.: 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.

Obs7.: 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”.

Obs8.: Os documentos anexos à Documentação Acadêmica, mesmo os que sejam assinados digitalmente, devem estar no formato PDF/A.

Conector v0.23.0

Aderente ao XSD V1.05 do MEC

12/01/2024

Atenção:

1. A partir da versão 0.23.0 do Conector, foi permitida a inserção de mais de um documento do mesmo tipo (exceto a documentação acadêmica) e com com Código de Segunda (context_id) no mesmo grupo de documento (groupId) desde que exista apenas um documento status válido e os demais no status revogado. Na prática, isso permite que documentos possam ser revogados sem ser deletados mesmo que os novos documentos não gerem um novo registro (ou seja, um novo código de segurança).

2. A partir da versão 0.23.0 do Conector, foi implementado a emissão de Histórico Escolar Final de maneira independente (avulso). Para isso deve ser usado o documento docType 1 e a tag HistoricoEscolarFinal.

3. É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.

4. 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.

Adicionado

● Rota para listagem de configurações de assinatura de documentos.

● Recuperação automática de arquivos preservados ausentes no armazenamento local.

● Data de inicialização de assinatura na resposta da rota de busca de estado do documento.

● Suporte a Históricos escolares avulsos.

● Versões do mesmo documento na resposta da rota de busca de documento por id.

Modificado

● Lógica de inserção de documentos em grupos para permitir códigos de segurança idênticos por tipo de documento.

Corrigido

● Acesso a arquivos de anexos na rota protegida de visualização de documentos.

● Precisão do cálculo do tempo de expiração de refreshTokens JWT.

● Esquema JSON TDadosDiplomadoPorDecisaoJudicial.

Observações:

Obs.: As 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.

Obs2.: 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.

Obs3.: 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).

Obs4.: 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.

Obs5.: 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.

Obs6.: 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.

Obs7.: 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”.

Obs8.: Os documentos anexos à Documentação Acadêmica, mesmo os que sejam assinados digitalmente, devem estar no formato PDF/A.

Conector v0.22.7

Aderente ao XSD V1.05 do MEC

24/11/2023

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.x é 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.

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.

Modificado

● Aumentada para 50 a quantidade de documentos listados pelo RAPSign.

● Aumento no timeout das requisições ao Serviço remoto da RNP.

Corrigido

● Algoritmo de cálculo de expiração de token JWT.

● Erro na geração de Documentação Acadêmica com Histórico Escolar indisponível.

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.

Conector v0.22.6

Aderente ao XSD V1.05 do MEC

09/10/2023

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.6 é 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.

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

● Verificação de compatibilidade de tags da Documentação Acadêmica e demais documentos derivados.

Modificado

●

Corrigido

● Esquema de atualização de Histórico Escolar na rota PUT /documents.

● Envio em lote de representações visuais.

● Envio de lotes de JSONs na rota POST /documents.

● Regra no JSON Schema da Documentação Acadêmica para o campo AnoMesProcessoSeletivo.

● Regra no JSON Schema do Histórico Parcial para o campo HoraEmissaoHistorico.

● Leitura de dados de Diploma Externo na geração do Arquivo de Fiscalização da Registradora

● Verificação de política de assinatura em arquivos XML de documentações acadêmicas externas.

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.

Conector v0.22.4

Aderente ao XSD V1.05 do MEC

06/09/2023

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.4 é 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.

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

● -

Modificado

● -

Corrigido

● Envio de lotes de JSONs na rota POST /documents.

● Regra no JSON Schema da Documentação Acadêmica para o campo AnoMesProcessoSeletivo.

● Regra no JSON Schema do Histórico Parcial para o campo HoraEmissaoHistorico.

● Leitura de dados de Diploma Externo na geração do Arquivo de Fiscalização da Registradora

● Verificação de política de assinatura em arquivos XML de documentações acadêmicas externas.

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.

Conector v0.22.2

Aderente ao XSD V1.05 do MEC

05/07/2023

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.x é 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.

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

● Visualização de arquivos anexados do tipo Outros na rota de visualização de documentos da versão 1.05.

● 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.

Conector v0.22.1

Aderente ao XSD V1.05 do MEC

08/06/2023

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 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.

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.

Conector v0.22.0

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 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.

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

● 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

● 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.

Conector v0.21.1

Aderente ao XSD V1.05 do MEC

06/04/2023

Atenção:

1. Antes da atualização do Conector para a versão 0.21.1 é 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.

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:

● Documentação da API para Representações Visuais de Histórico Escolar e Currículo Escolar.

● Rota de inserção de Representações Visuais de Histórico Escolar e Currículo Escolar.

● Esquemas JSON das Representações Visuais de Histórico Escolar e Currículo Escolar.

● Rota para reiniciar o processamento de todas as assinaturas de um documento.

● Logs mais descritivos no daemon de finalização de assinaturas.

● Script de atualização de configuração de tipo de documento das Representações Visuais de Histórico Escolar e Currículo Escolar.

● Filtro de tipo de grupo na rota de listagem de grupos.

● Verificação de compatibilidade de versão do Conector com a versão das configurações dos documentos.

● Variável de timeout do servidor do Conector (default 10 minutos).

Modificado:

● (break change) URL de arquivos anexados na rota de visualização de documentos no lugar do base64.

● Transição para o estado zero em documentos recém inseridos.

● Rota de retentar assinatura de documentos para reiniciar apenas a última assinatura.

● Limite máximo de caracteres definido para 5K em campos de descrição nos esquemas JSON.

● Mecanismo de identificação de documentos parados em estado de construção de assinatura.

● Algoritmo de geração de código de validação de Documentação Acadêmica Externa.

Corrigido:

● Padrão de timestamp nos logs da API do Conector.

● Falha na URL de visualização de documentações comprobatórias em caso de visualização em formato JSON do documento.

● 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.: 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.

Versões anteriores

Conector v0.20.1

Aderente ao XSD V1.05 do MEC

07/02/2023

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. 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.

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:

● Rota para reiniciar o processamento de todas as assinaturas de um documento.

● Logs mais descritivos no daemon de finalização de assinaturas.

● Documentação da API para Currículo Escolar.

● Rota de inserção de Currículo Escolar.

● Suporte para a visualização gráfica do Currículo Escolar.

● Algoritmo de geração de código de validação do Currículo Escolar com as regras do MEC.

● Utilitários de construção e validação de DDR para o Currículo Escolar.

● Esquemas JSON e XSD do Currículo Escolar.

Modificado:

● Rota de retentar assinatura de documentos para reiniciar apenas a última assinatura.

● Limite máximo de caracteres definido para 5K em campos de descrição nos esquemas JSON.

Corrigido:

● Inconsistência de alguns atributos nos esquemas JSONs.

● Visualização de assinaturas de arquivamento na rota de visualização de documentos.

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.

Conector v0.20.0

Aderente ao XSD V1.05 do MEC

02/01/2023

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. 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.

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:

• Documentação da API para Currículo Escolar;

• Rota de inserção de Currículo Escolar;

• Suporte para a visualização gráfica do Currículo Escolar;

• Algoritmo de geração de código de validação do Currículo Escolar com as regras do MEC;

• Utilitários de construção e validação de DDR para o Currículo Escolar;

• Esquemas JSON e XSD do Currículo Escolar.

Corrigido:

• Visualização de assinaturas de arquivamento na rota de visualização de documentos.

Observações:

Obs1.: 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.

Conector v0.19.1

Aderente ao XSD V1.05 do MEC

05/12/2022

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. O MEC sinalizou que os documentos do tipo Currículo Escolar (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.

4. 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.

Adicionado

• 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).

Alterado

• Algoritmo de geração de código de validação do histórico acadêmico.

Corrigido

• Sanitização de arquivos XML enviados pela rota de inserção de documentos.

• Visualização de arquivos XMLs com formatações específicas.

Observações:

Obs1.: O MEC sinalizou que os documentos do tipo Currículo Escolar (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 listar 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) dos 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 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 mesmos dados informados 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 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.

Conector v0.18.3

Aderente ao XSD V1.04.1 do MEC

17/10/2022

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.

Adicionado

• 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.

• Suporte à emissão, assinatura e visualização da Lista de Diplomas Anulados.

• Suporte à emissão, assinatura e visualização do Arquivo de Fiscalização da Registradora.

• Suporte à emissão, assinatura e visualização do Arquivo de Fiscalização de Emissora.

• RAPSign Web 0.3.12 com suporte à Lista de Diplomas Anulados, Arquivo de Fiscalização da Registradora e Arquivo de Fiscalização de Emissora.

• 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.

Alterado

• Limite de caracteres máximo aumentados para 5k no campo InformacoesAdicionais do JSON do diploma.

• (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.

Corrigido

• Visualização de documentação comprobatória que não suportava vários documentos do mesmo tipo.

• Falha que não atualizava o estado de documentos dentro de um grupo de documentos.

• Suporte à segunda via nato física do histórico acadêmico integral.

Observações:

Obs1.: 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 listar 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) dos diplomas. Nesse caso o docId informado deve ser sempre de documentos do tipo 2 (diploma digital)

Obs2.: 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.

Obs3.: 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.

Conector v0.18.1

Aderente ao XSD V1.04.1 do MEC

27/09/2022

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.

Adicionado

• Suporte à emissão, assinatura e visualização da Lista de Diplomas Anulados.

• Suporte à emissão, assinatura e visualização do Arquivo de Fiscalização da Registradora.

• Suporte à emissão, assinatura e visualização do Arquivo de Fiscalização de Emissora.

• RAPSign Web 0.3.12 com suporte à Lista de Diplomas Anulados, Arquivo de Fiscalização da Registradora e Arquivo de Fiscalização de Emissora.

• 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.

Alterado

• (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.

Corrigido

• Falha que não atualizava o estado de documentos dentro de um grupo de documentos.

• Suporte à segunda via nato física do histórico acadêmico integral.

Observações:

Obs1.: 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 listar 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) dos diplomas. Nesse caso o docId informado deve ser sempre de documentos do tipo 2 (diploma digital)

Obs2.: 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.

Obs3.: 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.

Obs4.: 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.

Obs5.: A versão 1.04.1 do normativo criou o elemento “ambiente” para a Documentação Acadêmica, Diploma Digital e Histórico Escolar. Para os documentos oficiais emitidos em produção, o elemento deve ser preenchido com o termo “Produção”.

Obs6.: Os documentos anexos à Documentação Acadêmica, mesmo os que sejam assinados digitalmente, devem estar no formato PDF/A.

Conector v0.17.1

Aderente ao XSD V1.04.1 do MEC

19/08/2022

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.

Adicionado

• Aba de informações adicionais no visualizador gráfico de documentos

Corrigido

• Falha que não atualizava o estado de documentos dentro de um grupo de documentos.

• Suporte à segunda via nato física do histórico acadêmico integral.

Observações:

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, Diploma Digital e 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” tanto para a Documentação Acadêmica, Diploma Digital e Histórico Escolar. 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.

Conector v0.17.0

Aderente ao XSD V1.04.1 do MEC

10/08/2022

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.

Adicionado

• Documentação da API para histórico acadêmico parcial.

• Rota de inserção de histórico acadêmico parcial.

• Utilitários de construção e validação de DDR para o histórico acadêmico parcial.

• Esquemas JSON e XSD do histórico acadêmico parcial.

Corrigido

• Visualização do Histórico Escolar Final no RAPSign WEB 0.3.9.

Observações:

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, Diploma Digital e 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” tanto para a Documentação Acadêmica, Diploma Digital e Histórico Escolar. 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.

Conector v0.16.0

Aderente ao XSD V1.04.1 do MEC

21/07/2022

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.

Adicionado

• Documentação da API para histórico acadêmico.

• Rota de inserção de histórico acadêmico.

• Algoritmo de geração de código de validação do histórico acadêmico com as regras do MEC.

• Utilitários de construção e validação de DDR para o histórico acadêmico.

• Esquemas JSON e XSD do histórico acadêmico.

• Informações detalhadas de erros de validação de documentos do MEC.

• Verificação de disponibilidade de slot em grupo para histórico acadêmico.

Corrigido

• Rota de busca de recibo que retornava erro para documentos revogados.

• Falha que não atualizava o recibo de um documento revogado.

• Regra de atributos obrigatórios para os elementos "IntercambioNacional" e "IntercambioInternacional".

• Builder de DDR que não processava o elemento "Habilitacao".

• Propriedades com definição de tipo errada nos esquemas JSON da versão 1.04.1 do diploma digital.

• 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}

Modificado

• Modificação da arquitetura do RAPSign WEB na versão 0.3.8.

Removido

• Suporte à inserção de documentos na versão 1.03 do diploma digital.

Observações:

Obs.1: 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.

Conector v0.15.1

Aderente ao XSD V1.04.1 do MEC

29/06/2022

Atenção:

1. É fortemente recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.

2. A emissão de documentos no ambiente de produção deve ser feita apenas com o Conector v0.15.0 (não usar o Conector v0.15.0-rc1 em Produção).

Adicionado

• Verificação de disponibilidade de slot em grupo para histórico acadêmico.

• Novo fluxo de validação de PDF/A para verificar assinaturas.

• Aumento de verbosidade dos logs no fluxo de assinatura de documentos.

• Validação da SituacaoAtualDiscente de acordo com as recomendações da norma.

• Esquemas JSON da versão 1.04.1 do diploma digital.

• Esquemas XSD da versão 1.04.1 do diploma digital.

• 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.

Corrigido

• Propriedades com definição de tipo errada nos esquemas JSON da versão 1.04.1 do diploma digital.

• Algoritmo de geração de código de validação.

• Propriedades que faltavam nos esquemas JSON da versão 1.04.1 do diploma digital.

• Corrigido o log de erro de conversão de PDF/A para informar corretamente a etapa em que houve falha.

• Corrigida uma condição de tratamento de erro que mantinha documentos no estado 12.

• (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.

Modificado

• 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.

Removido

• Suporte à inserção de documentos na versão 1.03 do diploma digital.

Observações:

Obs.1: 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.

Conector V0.15.0

Aderente ao XSD V 1.04.1 do MEC

23/06/2022

Atenção:

1. É fortemente recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.

2. A emissão de documentos no ambiente de produção deve ser feita apenas com o Conector v0.15.0 (não usar o Conector v0.15.0-rc1 em Produção).

Adicionado

• Novo fluxo de validação de PDF/A para verificar assinaturas.

• Aumento de verbosidade dos logs no fluxo de assinatura de documentos.

• Validação da SituacaoAtualDiscente de acordo com as recomendações da norma.

• Esquemas JSON da versão 1.04.1 do diploma digital.

• Esquemas XSD da versão 1.04.1 do diploma digital.

• 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.

Modificado

• 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.

Corrigido

• Algoritmo de geração de código de validação.

• Propriedades que faltavam nos esquemas JSON da versão 1.04.1 do diploma digital.

• Corrigido o log de erro de conversão de PDF/A para informar corretamente a etapa em que houve falha.

• Corrigida uma condição de tratamento de erro que mantinha documentos no estado 12.

• (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.

Removido

• Suporte à inserção de documentos na versão 1.03 do diploma digital.

Observações:

Obs.1: 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.

Conector V0.13.2

Aderente ao XSD V 1.03 do MEC

24/01/2022

Atenção:

1. É fortemente recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.

2. Os limites de tamanho atual do serviço são: 25MB por documento e 50 MB por requisição (para envio de documentos em lote).

Corrigido

• Falha na atualização de recibos de metadados dos documentos.

• Falha na atualização de recibos de documentos revogados.

Conector V0.13.0

20/12/2021

Atenção:

1. É fortemente recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.

2. Para a correta utilização do RAP Sign WEB, o Conector e o próprio RAP Sign WEB devem estar configurados para serem acessados via HTTPS.

Adicionado

• Suporte à versão 1.03 dos XSDs do MEC;

• Suporte do RAPSign Web ao sistema operacional Linux (distribuição Ubuntu);

• Suporte do RAPSign Web à certificados digitais em nuvem dos tipos SafeID e NeoID *. Para mais informações, contatar o suporte.

*Requisitos adicionais

Corrigido

• Tamanho máximo da requisição de conversão e validação de PDF/A aumentado para 50MB;

• Concorrência no processo de construção de documentos assinados simultaneamente;

• Utilitário de construção de DDR que podia não adicionar os dados corretos do endereço do Polo;

• Logging de inicialização de assinatura que apresentava apenas uma mensagem genérica.

Removido

• Suporte à versão 1.02 dos XSDs do MEC.

Observações:

• 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 ./

• É possível utilizar a ferramenta ngrok para se criar uma conexão HTTPS provisória para realizar os testes iniciais com o RAP Sign WEB. O ngrok pode ser instalado com o seguinte comando:

sudo snap install ngrok

• E para criar a conexão é possível utilizar o comando:

ngrok http <porta>

Conector v0.12.0

17/11/2021

Atenção:

1. É fortemente recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.

2. Para a correta utilização do RAP Sign WEB, o Conector e o próprio RAP Sign WEB devem estar configurados para serem acessados via HTTPS.

Modificado

• Aumentada a quantidade de tentativas de conversão e validação de PDF/A antes de entrar em estado de erro.

Corrigido

• Falha na rota de reiniciar registro de documentos em estado e erro local e preservados no RAP Server.

• Falha no carregamento da propriedade visual Código EMEC para cursos que possuem apenas o número do processo.

• Erro no utilitário de construção de DDR que, eventualmente, não incluía o atributo DataConclusao no XML gerado.

Observações:

• 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 ./

• É possível utilizar a ferramenta ngrok para se criar uma conexão HTTPS provisória para realizar os testes iniciais com o RAP Sign WEB. O ngrok pode ser instalado com o seguinte comando:

sudo snap install ngrok

• E para criar a conexão é possível utilizar o comando:

ngrok http <porta>

Conector v0.11.3

25/10/2021

Atenção:

1. É fortemente recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.

2. Para a correta utilização do RAP Sign WEB, o Conector e o próprio RAP Sign WEB devem estar configurados para serem acessados via HTTPS.

Adicionado

• Disponibilização do RAP Sign WEB para Firefox (ao acessar o RAPSign WEB no navegador Firefox o usuário será redirecionado, no primeiro uso, para a instalação da extensão).

• Atualização do RAP Sign Desktop Linux (v 1.0.5).

• Detecção de arquivos PDF assinados durante a conversão automática para PDF/A.

• Atributo signerId (CPF) na lista de assinaturas do documento na rota de busca de estado de documentos.

Modificado

• Arquivos de deploy do Docker para ajuste de segurança e permissões de escrita nos volumes.

Corrigido

• Padrão do dado “Número” para Atos Regulatórios (Autorização, Credenciamento, Reconhecimento, etc).

• Falha no filtro de busca de documentos por propriedades visuais na rota de coleta de assinaturas.

• Erro de assinatura para documentos grandes.

• Erro ao exportar certificados pelo RAP Sign WEB.

• Erro de assinar com assinante substituto.

Observações:

• 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 ./

• É possível utilizar a ferramenta ngrok para se criar uma conexão HTTPS provisória para realizar os testes iniciais com o RAP Sign WEB. O ngrok pode ser instalado com o seguinte comando:

sudo snap install ngrok

• E para criar a conexão é possível utilizar o comando:

ngrok http <porta>

Conector v0.11.0

20/08/2021

• A primeira vez que o Conector v0.11.0 for executado será realizado a migração dos arquivos do banco de dados de integração para um sistema de arquivos. O local default desse sistema de arquivo é indicado pela variável RAP_DATA_STORAGE_DIR do arquivo docker-compose.

• Para seguir o normativo do MEC, após a atualização para a versão 0.11.0 do Conector, não serão mais aceitos documentos baseado na versão 1.01 dos XSDs.

Adicionado​

• Disponibilização do RAP Sign WEB para Google Chrome e Windows.

• Novo utilitário de construção e validação de DDR para a versão 1.02 do diploma digital.

• Esquemas JSON e XSD da versão 1.02 do diploma digital.

• Melhorada a rota de reinicialização de registro de documentos para cancelar automaticamente registros em andamento no servidor de preservação do RAP.

• Alterado o esquema de armazenamento de arquivos de documentos processados para usar a persistência em volumes Docker.

• Cancelamento de registro de documentos na rota de reiniciar registro.

Modificado​

• Ajustadas as propriedades visuais de documentos para exibir Nome, Matrícula, Curso e Código EMEC no RAPSign.

• Melhorada a mensagem de inicialização da API com informações sobre a versão, modo de execução e a porta do servidor.

Corrigido​

• Ajustada a validação do yourNumber na rota de recuperação de documentos registrados para permitir caracteres especiais.

• Erro que mantinha documentos no estado de inicialização de registro indefinidamente.

Removido​

• Utilitário de construção e validação de DDR para a versão 1.01 do diploma digital.

Conector v0.9.0

17/05/2021

Adicionado

• Geração de código de validação com dados opcionais na versão 1.01 do diploma digital;

• Verificação de uso de yourNumber na inserção de documentos;

• Filtro para listar documentos por tipo;

• Novo utilitário de construção e validação de DDR para a versão 1.01 do diploma digital;

• Esquemas JSON e XSD da versão 1.01 do diploma digital;

• Validação de JSON Web Tokens usando o RAP Server;

• Melhorias no log de erros dos serviços;

• Atributos documentType e securityCode ao listar documentos

• Atributos documentType, groupId e yourNumber ao buscar um documento;

• Metadados para o registro de documentos na versão 1.01 do diploma digital do RAP;

• Propriedades visíveis para a assinatura de documentos na versão 1.01 do diploma digital.

Modificado

• Nomenclatura dos metadados de inserção de documento para o formato camelCase (clientId, yourNumber, docType, dltId, mimeType, clientSignature, isDocSigned);

• Regex da referência do diploma no JSON de inserção da representação visual (ReferenciaDiploma pode ser preenchido com valor securityCode da rota GET /documents/{docId}/);

• Porta 80 como padrão do Conector (podendo ser alterado no docker-compose).

Corrigido

• Campos que poderiam conter valores null nas respostas das requisições;

• Tipo do metadado isDocSigned para ser uma string "true" ou "false";

• Erro na codificação de PDFs na rota de recuperação de documentos preservados;

• Filtro de estado não aplicado corretamente em documentos em estados de erro após a geração;

• Atributo securityCode que permanecia omitido ao invés de uma string vazia ao buscar documentos não processados;

• Transações nas operações de atualizar e remover informações para garantir a consistência de dados.

Removido

• Dados inutilizados enviados para o registro de documentos no servidor do RAP;

• Suporte à inserção de documentos na versão 1.00 do diploma digital;

• Esquemas JSON com suporte a XML na versão 1.01 do diploma digital;

• Dependências inutilizadas.

Conector v0.8.1

0.8.1 - 22-03-2021

Adicionado

● Melhorias da documentação da API no Swagger. ● Estado de assinaturas do documento na rota de busca de estado de documentos. ● Opção de remoção em cascata de documentos. ● Validador de sequência de remoção de documentos. ● Validador de sequência de inserção de documentos. ● Rotas de inserção, listagem e remoção de grupos de documentos. ● Atualização automática de recibo de documentos. ● Conversão e validação de PDF/A para anexos de Documentação Acadêmica e arquivos de Representação Visual. ● Arquivos de Documentação Comprobatória e AtoDesignacao, caso anexados na Documentação Acadêmica, devem ser no formatos PDF/A.

Modificado

● Regra de inserção de Representação Visual ajustada para impedir arquivos duplicados. ● Porta padrão da API alterada para 80. ● Networking do docker ajustado para usar o driver padrão. ● Procedures de retry reimplementadas em JavaScript.

Corrigido

● Inconsistência em atributos no esquema JSON da Documentação Acadêmica (TermoResponsabilidade e DocumentacaoComprobatoria são opcionais). ● Rota de autenticação de documentos que retornava vazio para documentos inválidos. ● Falha na reinserção de um documento após deletá-lo. ● Recibo do documento que permanecia null ao invés de um objeto vazio para documentos não registrados.

Removido

● Rota de remoção de documentos por intervalo de tempo. ● Suporte à upload de arquivos XML para a inserção de Documentação acadêmica e Diploma.

(Apenas para Universidades Federais que aderiram ao módulo de registradora para terceiros)

Conector de Diplomas Externos v0.22.1

Aderente ao XSD V1.05 do MEC

08/06/2023

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 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.

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.

Conector de Diplomas Externos v0.22.0

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”.

Conector de Diplomas Externos v0.21.1

Aderente ao XSD V1.05 do MEC

06/04/2023

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”.

Versões anteriores

Conector de Diplomas Externos v0.19.1

Aderente ao XSD V 1.05 do MEC

05/12/2022

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. 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.

Adicionado

• 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).

Corrigido

• Sanitização de arquivos XML enviados pela rota de inserção de documentos.

• Visualização de arquivos XMLs com formatações específicas.

Observações:

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”.

Conector de Diplomas Externos v0.18.3

Aderente ao XSD V 1.04.1 do MEC

17/10/2022

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.

Adicionado

• 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.

Alterado

• 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.

Corrigido

• 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.

Observações:

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”.

Conector de Diplomas Externos v0.18.1

Aderente ao XSD V 1.04.1 do MEC

27/09/2022

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.

Adicionado

• 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.

Alterado

• 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.

Corrigido

• 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.

Observações:

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”.

Conector de diplomas externos v0.15.2

Aderente ao XSD V 1.04.1 do MEC

07/07/2022

Atenção:

1. É recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.

Adicionado

• 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.

Corrigido

• 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.

Modificado

• 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.

Removido

• Suporte à inserção de documentos na versão 1.03 da documentação acadêmica externa e do diploma digital.

Observações:

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.

Conector de diplomas externos v0.14.0

Aderente ao XSD V 1.03 do MEC

07/02/2022

Atenção:

1. É fortemente recomendado que seja feito um backup do banco de dados do Conector ANTES da realização da atualização.

2. Os limites de tamanho atual do serviço são: 25MB por documento e 50 MB por requisição (para envio de documentos em lote).

Adicionado

• 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.

Corrigido

• (break change) Rota de atualização de documentos que permitia a atualização de metadados.

Observações:

Comandos para realizar backup do banco de dados da integração

1. Pré-Instalação

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).

2. Atualização do Conector

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.

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.

3.1 Fluxo de geração do Diploma Externo

1. 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).

3.2 Preenchimento

1. 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.

3.3 Preencha os metadados JSON para geração do XML do Diploma Digital Externo:

a. O JSON é composto pela seção meta e pela seção data.

i. A seção meta será usada para controle dos documentos.

1. 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.

3.4 Validação dos dados JSON antes do início da geração

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.

3.5 Revogação de Diplomas Externos

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.