BRbry
Completadores

Adicionar Carimbo do tempo de Arquivamento extra XAdES

post/xml/v1/upgrade/extra-archive-timestamp

Request

Headers

Token de acesso aos serviços BRy emitido no BRy Cloud. É obrigatório em todas as requisições ao HUB. Para utilizar esta documentação é necessário inserir o token em Authorize.

Request body multipart/form-data

signature[0]string binary required

Documento contendo a assinatura. Para lotes, basta incrementar o valor do índice, por ex: signature[0], signature[1]

includeXPathEnvelopedboolean

Define se a assinatura onde será adicionado o novo Carimbo do tempo de Arquivamento extra ignora as demais assinaturas do documento em seu cálculo de hash. [Valores disponíveis: true ou false / Default: true].

generateSimplifiedXMLDSigboolean

Define se o novo Carimbo do tempo de Arquivamento deverá ser gerado com tags XML simplificadas (e.g. sem o ds: em Signature por exemplo). Particularmente útil para os casos onde a assinatura AD-RA / ETSI_LTA já existente segue a regra de namespace simplificada que não tem prefixos (ds:, xades141:, etc.) em suas tags XML. [Valores disponíveis: true ou false / Default: false].

returnTypestring

Define o tipo de retorno da requisição. LINK retorna um link para download de cada arquivo assinado na resposta JSON. BASE64 retorna o arquivo assinado, codificado em Base64. Caso LINK, o arquivo será excluído da cache após o download. [Valores disponíveis: LINK ou BASE64 / Default: LINK].

hashAlgorithmstring required

Algoritmo de HASH. [Valores disponíveis: SHA1, SHA256, SHA512]

signatureFormatstring required

Formato da assinatura. Por ora, a API suporta apenas ENVELOPED. [Valores disponíveis: ENVELOPED]

nodeIDstring

Define um ID de nodo de assinatura específico no documento onde deverá ser adicionado o novo Carimbo do Tempo de Arquivamento extra XAdES. Caso seja inserido um ID inexistente, o carimbo será adicionado na última assinatura feita no documento.

Example request

{
  "returnType": "LINK",
  "hashAlgorithm": "SHA256",
  "signatureFormat": "ENVELOPED",
  "nodeID": "Sign-1"
}

Response

The upgrade response.

statusinteger
timestampinteger
documentNamestring
messagestring
chavestring
documentstring

Example response

[
  {
    "status": 200,
    "timestamp": 2272158000,
    "documentName": "Nome do documento, se houver",
    "message": "Mensagem do erro, se houver",
    "chave": "Chave do erro, se houver",
    "document": "Base 64 da resposta se tipoRetorno igual a BASE64",
    "link": {
      "href": "https://link_para_recuperar_documento_Assinado"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.