Utilitários

Preparar documento PDF realizando manipulações com imagem e texto

post/preparador/v2/preparar

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

documentostring binary required

Documento no formato PDF que será assinado. Obs: Para assinar múltiplos documentos, é necessário adicionar entradas ‘documento’ tantas vezes quanto forem necessárias.

pagina_adicionalstring[]

Documento no formato PDF que será unido ao arquivo informado em 'documento’. Para unir múltiplos documentos, é necessário adicionar entradas ‘pagina_adicional’ tantas vezes quanto forem necessárias.

configuracao_imagemstring application/json

Configuração dos parâmetros de posição, dimensão e visualização da imagem. Deve ser informado no formato JSON array.</br> altura: Altura (em mm) da imagem que será inserida.</br> largura: Largura (em mm) da imagem que será inserida.</br> coordenadaX: Define o deslocamento horizontal (em mm) da imagem em relação a posição definida no parâmetro "posicao", sendo o valor default o canto inferior esquerdo da página. Valores positivos deslocam a imagem para a direita e para cima, enquanto negativos para a esquerda e para baixo..</br> coordenadaY: Define o deslocamento vertical (em mm) da imagem em relação a posição definida no parâmetro "posicao", sendo o valor default o canto inferior esquerdo da página. Valores positivos deslocam a imagem para a direita e para cima, enquanto negativos para a esquerda e para baixo..</br> posicao: Define a origem 0,0 do campo em relação aos quatro cantos da página. [Valores disponíveis: INFERIOR_DIREITO, INFERIOR_ESQUERDO, SUPERIOR_DIREITO e SUPERIOR_ESQUERDO].</br> pagina: Define a(s) página(s) na qual a imagem será adicionada. [Valores disponíveis: PRIMEIRA, ULTIMA e TODAS].</br> numeroPagina: Define o índice da página na qual a imagem será adicionada. A contagem do índice de páginas inicia em 1.</br> posicaoBorda: Define que a imagem será posicionada centralizada em uma das bordas da página. [Valores disponíveis: BORDA_DIREITA, BORDA_ESQUERDA, BORDA_INFERIOR e BORDA_SUPERIOR].</br> rotacaoImagemBorda: Define a rotação da imagem para os casos de página em modo paisagem ou imagem de assinatura posicionada na borda.[Valores disponíveis: ANTI_HORARIO_90_GRAUS e HORARIO_90_GRAUS].</br>

configuracao_textoobject

Configuração do texto que será inserido na assinatura. Deve ser informado no formato JSON array.</br> texto: Define o texto que será incluído no campo da assinatura. </br> pagina: Define a(s) página(s) na qual a imagem será adicionada. [Valores disponíveis: PRIMEIRA, ULTIMA e TODAS].</br> numeroPagina: Define o índice da página na qual a imagem será adicionada. A contagem do índice de páginas inicia em 1.</br> fonte: Define a fonte do texto. O valor padrão é HELVETICA. [Valores disponíveis: COURIER, HELVETICA, TIMES_NEW_ROMAN].</br> tamanhoFonte: Define o tamanho da fonte do texto. O valor padrão é 10. </br> coordenadaX: Define o deslocamento horizontal do texto em relação ao canto inferior esquerdo da página. Valores positivos deslocam a imagem para a direita e para cima, enquanto negativos para a esquerda e para baixo.</br> coordenadaY: Define o deslocamento vertical do texto em relação ao canto inferior esquerdo da página. Valores positivos deslocam a imagem para a direita e para cima, enquanto negativos para a esquerda e para baixo.</br> rotacaoTexto: Define a rotação do texto. [Valores disponíveis: ANTI_HORARIO_90_GRAUS e HORARIO_90_GRAUS].</br>

imagemstring binary

Imagem que será inserida no campo de assinatura. Atualmente os formatos suportados são JPEG, PNG e BMP.

Example request

{
  "configuracao_pagina_adicional": {
    "paginas": [
      "PRIMEIRA"
    ]
  },
  "configuracao_imagem": "[{\"altura\": 30, \"largura\": 50,  \"coordenadaX\":10,  \"coordenadaY\":10, \"posicao\": \"INFERIOR_ESQUERDO\", \"pagina\": \"PRIMEIRA\", \"numeroPagina\":1, \"posicaoBorda\":\"BORDA_INFERIOR\",\"rotacaoImagemBorda\":\"HORARIO_90_GRAUS\" }]"
}

Response

Operation response

Changes

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