BRbry
Assinador PDF

Inicializar Assinatura PDF/PAdES

post/fw/v1/pdf/pkcs1/assinaturas/acoes/inicializar

Request

  • Base URL
    https://cloud-hom.bry.com.br
  • Auth
    API key in header Authorization

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

documento[0]string binary required

Documento no formato PDF que será assinado. Para lotes, basta incrementar o valor do índice, por ex: documento[0], documento[1]

imagem[0]string binary

Imagem que será inserida no campo de assinatura. Atualmente os formatos suportados são JPEG, PNG e BMP. Obs: Para imagens específicas para cada documento, é necessário adicionar entradas 'imagem[i]' para cada documento do lote.

imagemFundo[0]string binary

Imagem que será inserida ao fundo do campo de assinatura. Atualmente os formatos suportados são JPEG, PNG e BMP. Obs: Para imagens de Fundo específicas para cada documento, é necessário adicionar entradas 'imagemFundo[i]' para cada documento do lote.

imagemAnotacao[0]string binary

Imagem que será inserida na anotacao. O nome do parâmetro deve corresponder ao campo "valor/nome" de uma anotação com "tipo" igual a IMAGEM. É possível utilizar a mesma imagem para diferentes anotações. Atualmente os formatos suportados são JPEG, PNG e BMP.

oidPoliticastring

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

senhasDecifragemstring

Array de strings com as senhas para decifragem dos documentos enviados no lote. Deve haver uma senha para cada documento do lote remetido, que será usada na decifragem do documento no respectivo índice do lote de documentos. Exemplo: ['1234','4321']

senhasCifragemstring

Array de strings com as senhas para cifragem dos documentos enviados no lote. Deve haver uma senha para cada documento do lote remetido, que será usada na cifragem do documento no respectivo índice do lote de documentos. Exemplo: ['1234','4321']

Example request

{
  "dados_inicializar": {
    "perfil": "TIMESTAMP",
    "formatoDadosEntrada": "Base64",
    "formatoDadosSaida": "Base64",
    "algoritmoHash": "SHA256",
    "certificado": "Certificado codificado em Base64",
    "razao": "Razao",
    "contato": "email@conta.com",
    "local": "Florianopolis",
    "tipoRestricao": "NENHUMA_RESTRICAO",
    "nonces": [
      "1"
    ]
  },
  "configuracao_imagem": [
    {
      "altura": 50,
      "largura": 50,
      "coordenadaX": "10",
      "coordenadaY": "15",
      "pagina": "PRIMEIRA",
      "posicao": "INFERIOR_ESQUERDO"
    }
  ],
  "configuracao_texto": [
    {
      "texto": "Texto a ser inserido.",
      "fonte": "COURIER",
      "tamanhoFonte": 12
    }
  ],
  "metadados": [
    {
      "nome_metadado1": "Valor do metadado a ser adicionado",
      "nome_metadado2": "Valor do metadado a ser adicionado"
    }
  ],
  "configuracao_anotacao[0]": [
    "{\r\n  \"altura\": 15,\r\n  \"largura\": 15,\r\n  \"numeroPagina\": \"1-1\",\r\n  \"posicaoBorda\": \"BORDA_DIREITA\",\r\n  \"nomeAnotacao\": \"Anotação Texto\",\r\n  \"tipo\": \"TEXTO\",\r\n  \"valor\": {\r\n    \"texto\": \"Texto de exemplo.\",\r\n    \"incluirCN\": true\r\n  }\r\n}",
    "{\r\n  \"altura\": 50,\r\n  \"largura\": 50,\r\n  \"coordenadaX\": -10,\r\n  \"coordenadaY\": 10,\r\n  \"pagina\": \"PRIMEIRA\",\r\n  \"posicao\": \"INFERIOR_DIREITO\",\r\n  \"nomeAnotacao\": \"Anotação Imagem\",\r\n  \"tipo\": \"IMAGEM\",\r\n  \"valor\": {\r\n    \"nome\": \"imagemAnotacao[0]\"\r\n  }\r\n}",
    "{\r\n  \"altura\": 75,\r\n  \"largura\": 75,\r\n  \"pagina\": \"ULTIMA\",\r\n  \"posicaoBorda\": \"BORDA_ESQUERDA\",\r\n  \"tipo\": \"QRCODE\",\r\n  \"valor\": {\r\n    \"texto\": \"https://cloud.bry.com.br\",\r\n    \"dimensao\": 200\r\n  }\r\n}"
  ],
  "oidPolitica": "2.16.76.1.7.1.11.1.1",
  "es_data": [
    {
      "event": "UUID do evento",
      "evidence": {
        "name": "Nome do Assinante",
        "email": "email@email.com.br"
      }
    }
  ],
  "configuracao_qrcode": [
    {
      "dimensao": 200,
      "texto": "https://cloud.bry.com.br",
      "tipoImagem": "png",
      "margem": "2",
      "nivelErro": "Q25"
    }
  ],
  "senhasDecifragem": "[\"1234\",\"4321\"]",
  "senhasCifragem": "[\"1234\",\"4321\"]"
}

Response

The initialization response

noncestring
formatoDadosEntradastring
formatoDadosSaidastring
algoritmoHashstring

Example response

{
  "nonce": "123456789",
  "formatoDadosEntrada": "Base64",
  "formatoDadosSaida": "Base64",
  "algoritmoHash": "SHA256",
  "assinaturasInicializadas": [
    {
      "messageDigest": "Hash correspondente ao conteúdo que deve ser assinado. O conteúdo deste campo deve ser cifrado com a chave privada do certificado (por exemplo via Bry Extension) e então enviado à finalização."
    }
  ]
}

Changes

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