Upload de template.
Com este endpoint você poderá enviar um novo template ao sistema, para futuramente enviar solicitações de assinatura para várias pessoas de forma simplificada.
ATENÇÃO! O envio do documento e dos templates possuem finalidades diferentes!
O upload de tempaltes conta com alguns campos do upload de documentos, como file, folder e name, porém possuí mais campos obrigatórios, os campos de preenchimento e assinatura!
Confira um vídeo sobre o upload de templates: https://youtu.be/BV8Ak5i7_hw
Para envio de documentos é necessário que o tipo da requisição seja um form-data!
Para enviar um template para o sistema, você deverá passar alguns parâmetros conforme abaixo:
- name: Nome do documento na plataforma (Front-end).
- file: Documento no formato PDF (Tipo FILE) ou base64 (Neste caso uma string com o mesmo).
- folder: Pasta na qual o documento será inserido, caso não seja passada o mesmo será criado na pasta principal.
- width_page: Largura da página do documento em pixels, será utilizada para calcular as demais dimensões de campos.
- Fields: Um array com quantos campos de preenchimento e/ou assinatura foram necessários, sendo que cada índice do array será um campo ou local de assinatura, conforme abaixo.
Campos de preenchimento e assinatura.
Confira um vídeo sobre o upload de templates: https://youtu.be/BV8Ak5i7_hw
Os campos de preenchimento e assinatura em templates funcionam de forma similar aos campos na solicitação de assinatura com documentos convencionais.
Porém a facilidade de definir os mesmos com antecedência nos templates lhe permite automatizar o envio de documentos padronizados em lote, uma vez que a solicitação não vai precisar mais destas informações.
Os campos de preenchimento e assinatura são divididos em dois grupos, os de assinatura e os de preenchimento/informações.
Campos de assinatura.
O campo de assinatura permite que o signatário crie um assinatura em texto, upload ou desenhando e insira a mesma no documento.
Ela também gera um registro de assinatura e criptografa o documento com um certificado digital para que o mesmo possa ser validado posteriormente.
Ela também gera um relatório de assinaturas ao final do documento, criando uma ou mais páginas extras com os dados de todos os signatários.
Porém atenção! Este relatório só é gerado em caso de ASSINATURA, solicitar nome e outros dados não é contabilizado como assinatura em um documento.
Dados necessários para a assinatura:
- xPos: Posição da assinatura no documento pelo eixo X da página (Calculado utilizando a width_page enviada).
- yPos: Posição da assinatura no documento pelo eixo Y da página (Calculado utilizando a width_page enviada).
- input: Para assinatura sempre o tipo "image".
- page: A página na qual aquela assinatura será inserida, é possível assinar várias páginas ou incluir mais de uma assinatura em uma mesma página, para isto envie no array FIELDS mais de um campo de assinatura (Seu cliente só cria uma).
- width: A largura do objeto na página, levando em consideração width_page, caso a largura da página seja 1000 pixels e a largura da assinatura 500, ela vai ocupar metade da página, e assim por diante.
- height: A altura do objeto na página, levando em consideração width_page proporcionalmente.
Campos de informações:
Os campos de dados permitem que você solicite dados do signatário e inclua eles no documento, finalizando o mesmo.
São permitidos quaisquer tipos de informações, como nome, CPF, data de nascimento e etc, além de ser permitido criar novos tipos.
Alguns campos são similares aos de assinatura, porém este tipo de dado possuí campos exclusivo
- xPos: Posição do campo no documento pelo eixo X da página (Calculado utilizando a width_page enviada).
- yPos: Posição do campo no documento pelo eixo Y da página (Calculado utilizando a width_page enviada).
- input: Para campos de preencimento sempre o tipo "text".
- page: A página na qual aquele campo de preenchimento será inserido.
- width: A largura do objeto na página, levando em consideração width_page, caso a largura da página seja 1000 pixels e a largura do campo 500, ele vai ocupar metade da página, e assim por diante.
- height: A altura do objeto na página, levando em consideração width_page proporcionalmente.
- align: Alinhamento do texto na página, podendo ser right, center ou left.
- bold: Se o texto será em negrito, se sim informar "bold".
- italic: Se o texto será em itálico, se sim informar "italic".
- underline: Se o texto será grifado, se sim informar "underline".
- strikethrough: Se o texto será taxado, se sim informar "strikethrough".
- fontsize: O tamanho da fonte do texto no documento em pixels, recomendamos o tamanho 14.
- color: A cor do texto no documento como um RGB hex (Ex: #000000).