Arquivos Auxiliares - Instalação e Atualização do Conector

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 ([e-mail]).

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.