Histórico Parcial - 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 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.