BRbry
Assinador PDF

Adiciona um carimbo de documento no PDF

post/fw/v1/pdf/carimbar

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

documento[0]string binary required

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

tipoRetornostring required

Tipo de retorno da resposta [Valores disponíveis: LINK e BASE64]. Caso LINK, o arquivo será excluído após o download.

algoritmoHashstring required

Algoritmo de hash do carimbo. [Valores disponíveis: SHA1, SHA256 e SHA512].

razaostring

Campo opcional para informar a razão para geração da assinatura.

contatostring

Campo opcional para informar o contato do signatário na geração da assinatura.

localstring

Campo opcional para informar o local onde a assinatura está sendo gerada.

restructureboolean

Define se será bloqueada a assinatura de arquivos PDF cuja tabela de estrutura de objetos esteja desestruturada. Caso o documento submetido não tenha nenhuma assinatura e tenha a tabela desestruturada, a API irá reestruturá-lo antes de assinar digitalmente. Recomendamos que o valor seja configurado como true, pois garante que o documento não será recusado por conta de problema na tabela de referências. [Valor Default: false]

imagem[0]string binary

Imagem que será inserida no campo do carimbo. 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 do carimbo. 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.

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

{
  "tipoRetorno": "LINK",
  "algoritmoHash": "SHA256",
  "razao": "Razao",
  "contato": "email@conta.com",
  "local": "Florianopolis",
  "configuracao_imagem": [
    {
      "altura": 50,
      "largura": 50,
      "coordenadaX": "10",
      "coordenadaY": "15",
      "pagina": "PRIMEIRA",
      "posicao": "INFERIOR_ESQUERDO",
      "campoAssinatura": "Nome do Campo de Assinatura"
    }
  ],
  "configuracao_texto": [
    {
      "texto": "Texto a ser inserido.",
      "fonte": "COURIER",
      "tamanhoFonte": 12
    }
  ],
  "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}"
  ],
  "configuracao_qrcode": [
    {
      "dimensao": 200,
      "texto": "https://cloud.bry.com.br",
      "tipoImagem": "png",
      "margem": "2",
      "nivelErro": "Q25"
    }
  ],
  "senhasDecifragem": "[\"1234\",\"4321\"]",
  "senhasCifragem": "[\"1234\",\"4321\"]"
}

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.