BRbry
Utilitários

Customizar documento PDF adicionando imagens, textos ou campos de assinatura. Algumas opções não podem ser utilizadas em documentos assinados.

post/pdf/v1/customize

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 que será customizado. Para lotes, basta incrementar o valor do índice, por ex: documento[0], documento[1]

pagina_adicional[0]string binary

Documento que será adicionado ao principal. Para lotes, basta incrementar o valor do índice, por ex: pagina_adicional[0], pagina_adicional[1]

configuracao_pagina_adicional[0]string

Um array de string contendo a localização da página onde os documentos informados em ‘pagina_adicional’ devem ser inseridos. A ordem do array deve seguir a mesma ordem de 'pagina_adicional[0]’. Não pode ser utilizado para arquivos já assinados. [Valores disponíveis: PRIMEIRA e ULTIMA].

imagem[0]string binary

Imagem que será adicionada ao documento, pode-se repetir este parâmetro para adicionar mais imagens, é possivel aplicar várias configuracao_imagem[i] a mesma imagem ou uma para cada imagem[i]. Para lotes, basta incrementar o valor do índice, por ex: imagem[0], imagem[1]. Não pode ser utilizado para arquivos já assinados.

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.

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].

restructureboolean

Define se o documento será reestruturado. Não pode ser utilizado para arquivos já assinados. Valor padrão é 'true'.

Example request

{
  "configuracao_imagem[0]": [
    {
      "altura": 50,
      "largura": 50,
      "coordenadaX": "10",
      "coordenadaY": "15",
      "pagina": "PRIMEIRA",
      "posicao": "INFERIOR_ESQUERDO"
    }
  ],
  "configuracao_texto[0]": [
    {
      "coordenadaX": "10",
      "coordenadaY": "15",
      "pagina": "PRIMEIRA",
      "numeroPagina": "0",
      "texto": "Texto a ser inserido.",
      "fonte": "COURIER",
      "tamanhoFonte": 12
    }
  ],
  "configuracao_campo[0]": {
    "altura": "50",
    "largura": "50",
    "campoAssinatura": "CampoAssinatura",
    "coordenadaX": "0",
    "coordenadaY": "0",
    "posicao": "INFERIOR_ESQUERDO",
    "pagina": "PRIMEIRA",
    "numeroPagina": "1",
    "posicaoBorda": "BORDA_INFERIOR",
    "rotacaoImagemBorda": "HORARIO_90_GRAUS"
  },
  "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}"
  ],
  "returnType": "LINK",
  "configuracao_imagem_qrcode[0]": [
    "{\r\n  \"altura\": 50,\r\n  \"largura\": 50,\r\n  \"pagina\": \"ULTIMA\",\r\n  \"posicaoBorda\": \"BORDA_SUPERIOR\",\r\n  \"configuracao_qrcode\": {\r\n    \"texto\": \"https://cloud.bry.com.br\",\r\n    \"dimensao\": 200\r\n  }\r\n}"
  ],
  "metadados[0]": {
    "2.16.76.1.4.2.2.2": "SC",
    "2.16.76.1.4.2.2.3": "Cardiologista",
    "nome_metadado1": "valor1",
    "nome_metadado2": 1234
  }
}

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.