BRbry
Assinador XML

Assinar XML/XAdES utilizando certificado em arquivo (Passo único) ⚠️

⚠️ Disponível somente para implantação on-premises

post/api/xml-signature-service/v1/signatures/pkcs12

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.

Senha do PKCS12 (.pfx/.p12) configurado para a assinatura. Deve ser fornecido em formato Base64.

Request body multipart/form-data

noncestring required

Nonce da requisição

signerFileNamestring required

Nome do arquivo pdf/p12 (sem sua extensão).

returnTypestring required

Define o tipo de retorno da requisição. LINK retorna uma resposta JSON, a qual possui links para downloads dos arquivos assinados. BASE64 retorna uma lista com arquivos assinados, codificados em Base64. Caso LINK, o arquivo será excluído da cache após o download.

hashAlgorithmstring required

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

profilestring required

Tipo de perfil desejado para a assinatura a ser gerada. [Valores disponíveis: BASIC, COMPLETE, ADRB, ADRT, ADRV, ADRC, ADRA, ETSI_B, ETSI_T, ETSI_LT, ETSI_LTA]

signatureFormatstring required

Formato da assinatura. [Valores disponíveis: ENVELOPED, ENVELOPING, DETACHED]

operationTypestring

Tipo de Operação. [Valores disponíveis: SIGNATURE, CO_SIGNATURE]

binaryContentstring

true = Documento original em qualquer formato<br>false = Documento original no formato xml

includeXPathEnvelopedstring

Define se a regra de XPath para que assinaturas anteriores sejam ignoradas em assinaturas enveloped será incluída ou não na assinatura.

generateSimplifiedXMLDSigstring

Define se a assinatura XML básica será gerada sem o prefixo do namespace XMLDSig nas tags da assinatura e se o identificador do certificado do signatário (emissor e serial) será incluído ou não no KeyInfo da assinatura.

includeSigningTimestring

Define se a hora local da assinatura será incluída nos atributos assinados.

originalDocuments[0][nonce]string

Nonce do documento original.

originalDocuments[0][content]string binary required

Arquivo que será assinado. Para lotes, basta incrementar o valor do índice, por ex: originalDocuments[0], originalDocuments[1]

originalDocuments[0][information]string

Demais informações sobre o arquivo.

originalDocuments[0][filename]string

Nome do arquivo.

originalDocuments[0][specificNode][id]string

ID do nodo a ser assinado.

originalDocuments[0][specificNode][name]string

Nome do nodo a ser assinado.

originalDocuments[0][specificNode][namespace]string

Namespace do nodo a ser assinado.

policyOidstring

Quando enviado, este parâmetro define o OID da política de assinatura a ser usada com perfil de assinatura selecionado.

lineBreakboolean

Define se deve ser utilizado quebra de linha na codificação de dados base64 na estrutura da assinatura como certificado, LCR, cadeia e carimbo do tempo. Padrão é True. Utilize o valor False somente se necessário para compatibilidade com outras plataformas.

Example request

{
  "nonce": "1",
  "signerFileName": "Nome do arquivo pfx/p12.",
  "returnType": "BASE64",
  "hashAlgorithm": "SHA256",
  "profile": "BASIC",
  "signatureFormat": "ENVELOPED",
  "operationType": "SIGNATURE",
  "binaryContent": "false",
  "includeXPathEnveloped": "true",
  "generateSimplifiedXMLDSig": "false",
  "includeSigningTime": "false",
  "canonicalizerType": "EXCLUSIVE",
  "originalDocuments[0][nonce]": "1",
  "policyOid": "2.16.76.1.7.1.6.2.4"
}

Response

OR
string[] required

Example response

{
  "identificador": "ABC123",
  "documentos": [
    {
      "hash": "ABCDEF123456",
      "links": [
        {
          "href": "https://link_para_recuperar_documento_Assinado"
        }
      ]
    }
  ]
}

Changes

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