> For the complete documentation index, see [llms.txt](https://ajuda.rnp.br/diplomas-digitais/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ajuda.rnp.br/diplomas-digitais/passo-a-passo/conector-local-1/conector-para-diplomas-externos/preenchendo-metadados-e-iniciando-uma-geracao-diploma-digital-externo.md).

# Preenchendo Metadados e iniciando uma Geração Diploma Digital Externo

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

<figure><img src="https://30362825-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MB-V5yqZBtdQcJVbpRg%2Fuploads%2FPYPC99I8nABzWo9Hn1LZ%2Fimage.png?alt=media&amp;token=2d34444a-c569-4c81-b128-e637c615f54a" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://30362825-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MB-V5yqZBtdQcJVbpRg%2Fuploads%2FZScEWYbzr1CouLxghAJM%2Fimage.png?alt=media&amp;token=ea7cf475-57c9-4844-a599-d210b8fc7f39" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://30362825-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MB-V5yqZBtdQcJVbpRg%2Fuploads%2FleXRhoqVzWbrszCQJCvw%2Fimage.png?alt=media&amp;token=949a6675-321a-4265-9fe5-306e38b6d5fe" alt=""><figcaption></figcaption></figure>

<figure><img src="https://30362825-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MB-V5yqZBtdQcJVbpRg%2Fuploads%2FQqKJtVlwxXHzgX5K1Huc%2Fimage.png?alt=media&amp;token=93161120-8b87-4017-9a40-a18e3f303d8c" alt=""><figcaption></figcaption></figure>

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://ajuda.rnp.br/diplomas-digitais/passo-a-passo/conector-local-1/conector-para-diplomas-externos/preenchendo-metadados-e-iniciando-uma-geracao-diploma-digital-externo.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.