API
New Horizon
Log In
API

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

post
https://example.com/pdf/v1/customize
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
file
required

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

file

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

string
Defaults to ["PRIMEIRA"]

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

configuracao_imagem[0]
array of objects

Configuração dos parâmetros de posição, dimensão e visualização da imagem. Deve ser informado no formato JSON. Não pode ser utilizado para arquivos já assinados. Obs: Para adicionar múltiplas imagens ao mesmo documento, é necessário adicionar entradas 'configuracao_imagem[i]' tantas vezes quanto forem necessárias.

configuracao_imagem[0]
configuracao_texto[0]
array of objects

Configuração do texto que será inserido no documento. Deve ser informado no formato JSON e pode configurar a posição do texto a ser inserido (coordenadaX, coordenadaY, pagina e numeroPagina). Não pode ser utilizado para arquivos já assinados. Obs: Para adicionar múltiplos textos ao mesmo documento, é necessário adicionar entradas 'configuracao_texto[i]' tantas vezes quanto forem necessárias.

configuracao_texto[0]
configuracao_campo[0]
object

Configuração dos parâmetros de posição, dimensão e visualização do campo no documento do lote, indicado no índice [i]. Deve ser informado no formato JSON. Para configurar múltiplos campos, deve ser enviado um array de JSON.

configuracao_anotacao[0]
array of objects

Lista das configurações que definem os parâmetros de posição, dimensão e visualização de uma anotação. Deve ser informado no formato JSON. Para cada documento que se deseja adicionar anotações, é necessário enviar configurações específicas de acordo com o índice do documento, por ex: configuracao_anotacao[0], configuracao_anotacao[1]. Para adicionar múltiplas anotações a um mesmo documento é necessário adicionar entradas 'configuracao_anotacao[i]' tantas vezes quanto forem necessárias.

configuracao_anotacao[0]
file

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.

file

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.

string

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

boolean

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

configuracao_imagem_qrcode[0]
array of objects

Configuração do QRCode que será inserido no documento. Deve ser informado no formato JSON e configurar a posição do QRCode (coordenadaX, coordenadaY, pagina e numeroPagina). Não pode ser utilizado para arquivos já assinados. Obs: Para adicionar múltiplas imagens de QRCode ao mesmo documento, é necessário adicionar entradas 'configuracao_imagem_qrcode[i]' tantas vezes quanto forem necessárias.

configuracao_imagem_qrcode[0]
metadados[0]
object

Lista dos pares de nome e valor dos metadados a serem adicionados no arquivo a ser assinado. Deve ser informado no formato JSON. Para lotes, basta incrementar o valor do índice, por ex: metadados[0], metadados[1].

Headers
string

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.

Responses

default

Para mais detalhes sobre as Respostas: link para as respostas de erro ou no formato properties

Updated about 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago