Listas de diplomas anulados
Toda IES registradora precisa publicar a lista de diplomas anulados: um arquivo XML assinado, no layout ListaDiplomasAnulados do MEC,
com os diplomas cujo registro ela anulou. O Digiploma gera, assina e publica essa lista para cada instituição que registra
diplomas (do tipo Registradora ou Emissora e Registradora). Instituições que são apenas emissoras não têm lista.
O arquivo público
A lista assinada mais recente de cada instituição é publicada, sem autenticação, na raiz da instância, com o código MEC da instituição como nome do arquivo:
https://www.digiploma.com.br/{iesCode}.xml
O que a lista contém
A lista é cumulativa: cada nova lista traz todas as anulações, e não só as feitas depois da lista anterior. Para cada diploma anulado pela
instituição, com os dois arquivos XML assinados, ela traz o código de validação, a data da anulação, o motivo (cancellationReason, como
Erro de Fato) e a observação (reason). Requisições de registro assinadas que foram canceladas também entram na lista. Diplomas anulados
temporariamente, não.
Cada lista tem um número sequencial e a data máxima para a próxima lista (DataMaximaProximaAtualizacao), 180 dias depois da geração.
Quando as listas são geradas
- Quando uma instituição registradora é criada, ou quando uma instituição passa a ser registradora.
- Periodicamente: uma verificação mensal gera a próxima lista quando faltam menos de 120 dias para a data máxima da lista atual, ou seja, cerca de dois meses depois da lista anterior. Em instalações on-premises, essa janela é configurável.
Anular um diploma não gera uma nova lista na hora: a anulação aparece na próxima lista.
Assinatura e status
As configurações da instituição definem como a lista é assinada:
- Automático: o próprio Digiploma assina a lista, com o certificado e-CNPJ da instituição (XAdES, política AD-RT da ICP-Brasil).
- Manual: o Digiploma envia a lista para o Lacuna Signer, na pasta da instituição, para que o signatário da instituição a assine.
status | Significado |
|---|---|
Created | Gerada e aguardando a assinatura no Signer (assinatura manual). |
Signed | Assinada. A lista publicada é a assinada mais recente. |
Operações
Todas as operações exigem a chave de API, com a permissão ViewCancellationList.
| Operação | Descrição |
|---|---|
GET /api/cancellation-lists/institute/{instituteId} | Uma página das listas da instituição. |
GET /api/cancellation-lists/ies-codes/{iesCode} | O mesmo, pelo código MEC da instituição. |
GET /api/cancellation-lists/institute/{instituteId}/latest | A lista assinada mais recente da instituição. |
GET /api/cancellation-lists/institute/{instituteId}/latest/xml, …/latest/xml-b64 | Baixar a lista assinada mais recente, como arquivo ou em Base64. |
GET /api/cancellation-lists/{id} | Uma lista. |
GET /api/cancellation-lists/{id}/xml, …/xml-b64, …/xml-ticket | Baixar uma lista, como arquivo, em Base64 ou com um ticket. |
As operações de listagem aceitam os parâmetros de paginação; Q busca o número sequencial exato, e os resultados são
ordenados pelo número sequencial. As operações latest exigem que a instituição já tenha uma lista assinada.
Uma lista (CancellationListModel) tem id, iesCode, iesName, sequenceNumber, status, version, creationDate,
maximumNextUpdateDate e, na assinatura manual, signerDocumentId e signerDocumentUrl.
Webhooks
| Evento | Quando |
|---|---|
CancellationListCreated | Uma lista foi gerada e enviada para o Signer (assinatura manual). |
CancellationListSigned | Uma lista foi assinada. |
Esses eventos são enviados conforme as configurações de webhook da instituição, ou as da organização. O evento CancellationListGenerated,
que aparece na referência da API, não é enviado. Veja Webhooks.