API

Respostas de sucesso e erro Diploma Digital

O retorno da finalização são os XMLs de Histórico Escolar Digital / Lista de Diplomas Anulados / Arquivo de Fiscalização assinados, codificados em Base64.

O retorno da finalização são os XMLs Diplomado / Documentação Acadêmica com um novo carimbo de arquivamento anexado à assinatura AD-RA da IES Registradora contida no documento.

Sucesso

  • Requisições que ocorrem com sucesso retornam código HTTP 200. Para mais detalhes com os dados, acesse a tabela:

O modelo da resposta JSON é mostrado abaixo:

Resposta da inicialização:

{
  "nonce": valor_do_nonce_requisicao,
  "signedAttributes": [{ "nonce": valor_do_nonce_assinatura, "content": "valor_atributos_assinados" }],
  "initializedDocuments": [{ "nonce": valor_do_nonce_assinatura, "content": "valor_documento_inicializado" }]
}

O modelo de resposta da finalização é representado como uma lista de assinaturas:

Resposta da finalização

[
"valor_assinatura_base64"
]

Retorno de sucesso

CódigoDescrição
200Operação executada com sucesso: resposta da etapa de inicialização/finalização.

Erro

  • Requisições que ocorrem com erro retornam código HTTP 4xx ou 5xx. Para mais detalhes com os dados, acesse a tabela:

O modelo da resposta JSON é mostrado abaixo:

{
  "status": valor_estado_http,
  "chave": "valor_da_chave",
  "message": "valor_mensagem_erro",
  "timestamp": "valor_data_e_hora_do_erro"
}

Retorno de erro de requisição

CódigoDescrição
400Bad Request (Requisição mal-formada)

Chaves de Erro para requisição mal-formada (API REST)

Chave de ErroDescrição
excecao.hub.requisicaoNão foi possível concluir o processamento da requisição com sucesso.
excecao.hub.recurso.inexistenteRecurso requisitado não existe. Recurso requisitado: {0}
excecao.hub.requisicao.param.nuloParâmetro {0} da requisição não pode ser nulo.
excecao.hub.content.typeO header 'Content-Type' enviado não é suportado. Valor enviado: {0} [Valor aceito: application/json]
excecao.hub.header.invalidoO header {0} da requisição deve ser informado.
excecao.hub.calcular.hashErro ao efetuar o cálculo do hash do documento assinado.
excecao.hub.obter.documento.assinadoErro ao recuperar o conteúdo assinado.
excecao.hub.cache.token.obterNão foi possível verificar a licença do BRyHUB.
excecao.hub.cache.token.gerarNão foi possível gerar o token FW2.
excecao.hub.algoritmo.hashParâmetro {0} informado não é um valor válido. [Valores disponíveis: SHA1, SHA256 e SHA512].
excecao.hub.decodificar.certificadoErro na decodificação do certificado fornecido. Certificado fornecido não é válido.
excecao.hub.perfilParâmetro 'perfil' informado não é um valor válido. [Valores disponíveis: {0} ]
excecao.hub.decodificar.base64Não foi possível decodificar o Base64 do conteúdo {0}.
excecao.hub.formatoParâmetro {0} informado não é um valor válido. [Valores disponíveis: {0} ]
excecao.hub.parametro.lista.vazioParâmetro {0} não pode ser vazio.
excecao.hub.requisicao.nonceValor de nonce {0} inválido. Deve ser informado um valor aleatório Big Integer.
excecao.hub.json.invalidoRequisição enviada mal formatada. Verifique o contéudo do campo json {0}.
excecao.hub.parametro.retornoÉ necessário definir o parâmetro 'returnType' na requisição. [Valores disponíveis: "BASE64" e "LINK"].
excecao.hub.parametro.retorno.invalidoParâmetro {0} informado não é um valor válido. [Valores disponíveis: BASE64 e LINK].
excecao.hub.operation.typeParâmetro 'operationType' informado não é um valor válido. [Valores disponíveis: SIGNATURE, CO_SIGNATURE]
excecao.hub.quantidade.noncesNúmero de nonces informados não condiz com a quantidade de documentos enviados na requisição.
excecao.hub.contexto.cacheNonce da requisição diferente do nonce retornado na inicialização ou o tempo em que o contexto inicializar permanece em cache expirou.
excecao.hub.pkcs12.certificadoO certificado {0} não foi encontrado.
excecao.hub.requisicao.parametroParâmetro {0} da requisição deve ser fornecido.
excecao.hub.certificate.factoryErro ao criar CertificateFactory.
excecao.hub.fw.clienteErro ao criar o cliente do BRy Framework.
excecao.hub.fw.contextoErro ao criar ContextoAssinaturaLocal.
excecao.hub.fw.finalizarErro ao finalizar assinatura no BRy Framework.
excecao.hub.fw.cadeiaNão foi possível obter o certificado {0} com chave de entidade: {1}
excecao.hub.fw.credencial.ausenteDeve ser informado o valor de Authorization no cabeçalho da requisição.
excecao.hub.fw.credencial.base64O valor do header 'fw_credencial' enviado não é uma String base64 válida.
excecao.hub.fw.credencial.formatoO valor do header 'fw_credencial' decodificado não atende ao formato válido aceito. [Formato aceito: Base64(usuario+senha)]
excecao.hub.fw.comunicacaoHTTP status: 400 - {0}
erro.cliente.assinatura.inicializarHTTP 401 Unauthorized
erro.cliente.conectarNão foi possível conectar ao serviço, porque o acesso não foi autorizado (HTTP 401). Favor confirmar suas credenciais ou busque entrar em contato com um administrador do sistema.
excecao.hub.kms.cifragemOcorreu um erro na operação de cifragem.
excecao.hub.kms.chaveNenhuma chave foi encontrada para o cpf {0} especificado.
excecao.hub.kms.certificadoA chave recuperada vinculada ao compartimento não possui chave pública.
excecao.hub.kms.tipo.credencialTipo de credencial inválido. [Valores disponíveis: "PIN" ou "TOKEN"].
excecao.hub.kms.auth.token.invalidoO CPF não possui certificados vinculado. Verifique o valor do header 'auth_token'.
excecao.hub.kms.cpf.invalidoNão foi encontrado certificado para o CPF {0}. Verifique o valor do CPF informado.
excecao.hub.kms.credencial.invalidaCredencial de acesso ao KMS não autorizada. Verificar o valor do header 'kms_credencial'.
excecao.hub.kms.dados.invalidosDados inválidos na requisição encaminhada ao BRy KMS.
excecao.hub.kms.indisponivelO serviço BRy KMS está indisponível no momento.
excecao.hub.kms.erro.internoOcorreu um erro interno no serviço BRy KMS.
excecao.hub.xml.signature.formatParâmetro 'signatureFormat' informado não é um valor válido. [Valores disponíveis: ENVELOPED e ENVELOPING]
excecao.hub.xml.canonicalizer.typeParâmetro 'canonicalizerType' informado não é um valor válido. [Valores disponíveis: INCLUSIVE e EXCLUSIVE]
excecao.signer.xml.conteudoO tipo dos dados da referência não é suportado.
excecao.signer.xml.conteudos.ausentesNão foram fornecidos dados para serem assinados.
excecao.signer.xades.decodificacao.certificadoErro ao decodificar o certificado desejado.
excecao.signer.xml.finalizar.assinaturas.ausentesNão foi possível finalizar a assinatura pois os hashes cifrados não foram fornecidos.
excecao.signer.xml.inicializar.documento.incompativelNão é possível assinar como ENVELOPED um documento assinado como {0}.
excecao.signer.xml.inicializar.tipo.incompativeisNão é possível realizar uma coassinatura {0} sobre uma assinatura {1}.
excecao.signer.xml.inicializar.binario.envelopedNão é possível realizar uma assinatura ENVELOPED com conteúdo binário como true.
excecao.signer.xml.documento.parsingNão foi possível realizar o parser do documento XML.
excecao.signer.xml.operacao.invalidaNão é possível realizar a operação de contra-assinatura sobre em assinaturas XML Básicas.
excecao.signer.xml.perfil.invalidoNão é possível gerar assinaturas XML Básicas com perfil CARIMBO.
excecao.signer.xml.formato.invalido.nodoAssinar nodo só é possível no formato enveloped.
excecao.signer.xml.nodo.assinar.ausenteNão foi possível localizar o nodo {0} para ser assinado.
excecao.signer.certificado.ausenteO certificado do signatário não foi informado.
excecao.hub.contabilidade.creditosSaldo insuficiente para operação desejada. Token de acesso já consta como bloqueado. Necessário adquirir créditos para desbloquear.
excecao.hub.contabilidade.creditos.adquirirSaldo insuficiente para operação desejada. Necessário adquirir créditos para utilização.
excecao.hub.token.emissor.unauthorizedEmissor do Token JWT é desconhecido ou não confiável.
excecao.hub.token.emissor.failFalha ao verificar a confiabilidade do token JWT.
excecao.hub.token.emissor.nullNenhum emissor de tokens JWT confiável listado no arquivo de configuração.
excecao.hub.token.corrompidoNão foi possível decodificar o token JWT enviado em 'Authorization'.
excecao.hub.token.invalidoO token JWT enviado está inválido.
excecao.signer.xml.documento.ausenteXLM do documento ausente.

Erro de processamento no servidor

CódigoDescrição
500Erro interno no servidor