Templates PDF

Sumário

1. Conceito

A funcionalidade de Template de PDF permite a criação de documentos-modelo com campos posicionados visualmente e vinculados aos signatários, viabilizando a padronização de documentos e a automação do envio de envelopes exclusivamente por meio de API.

2. Alterações no GED

Quando um novo PDF é salvo no GED, o sistema registra automaticamente:

• Altura da primeira página
• Largura da primeira página
• Quantidade total de páginas

Essa funcionalidade é controlada por um feature toggle. Caso o recurso não esteja habilitado, o GED mantém seu comportamento original, sem armazenar as dimensões do arquivo.

As informações salvas são utilizadas nas validações de compatibilidade entre o arquivo enviado via API e o Template aplicado.

3. Menu Template

O módulo SIGN conta com um menu dedicado para o gerenciamento de Templates de PDF. Por meio dessa funcionalidade, é possível criar, editar, formatar e excluir templates de forma centralizada e padronizada.

Caminho: SIGN > Templates de PDF

4. Criação de Templates

Para criar um Template é necessário informar:

5. Edição de Templates

Ao clicar em Editar, é exibido um painel lateral contendo:

• Nome do Template
• Ícone do Template
• PDF anexado

Ações disponíveis:

• Download do PDF
• Alterar/substituir PDF

6. Formatação de Templates

Nesta etapa, são definidas as regras de assinatura e o posicionamento dos campos no documento, respeitando a ordem e o vínculo com os signatários.

7. Uso da API

7.1 Como funciona

Para utilizar um Template ao criar um envelope via API, informe o campo pdfTemplateId dentro de cada item de envelopeDocuments. O SIGN validará automaticamente dimensões e número de páginas e aplicará os campos configurados no Template.

7.2 Exemplo de Requisição Completa

{
				"signers": [
				{
				"name": "LUCAS DE CARVALHO",
				"email": "teste@senior.com.br",
				"phoneNumber": "(47) 99999-9999",
				"username": "admin@teste.com.br",
				"orderSign": 1,
				"signerType": "MANDATORY",
				"communicationChannel": {
				"email": true,
				"platform": false
				}
				},
				{
				"name": "LUCAS EDUARDO",
				"email": "teste1@senior.com.br",
				"phoneNumber": "(47) 99999-9999",
				"username": "admin@teste1.com.br",
				"orderSign": 1,
				"signerType": "MANDATORY",
				"communicationChannel": {
				"email": true,
				"platform": false
				}
				}
				],
				"conectors": [],
				"envelopeDocuments": [
				{
				"documentVersion": "d92098b9-592c-4525-882f-bcdfa3e54976",
				"envelopePosition": 1,
				"pdfTemplateId": "f78cd463-c5be-4fa2-b5b5-27f796d92c78"
				}
				],
				"envelopeDraftId": "",
				"name": "Teste",
				"documentsVersions": [
				"d92098b9-592c-4525-882f-bcdfa3e54976"
				],
				"askGeolocation": "DONT_ASK_LOCATION",
				"daysToNotify": 0,
				"daysToExpire": 120,
				"permissions": [],
				"notificateAuthor": false,
				"searchJobPosition": false,
				"recurrentNotificationIntervalDays": 0
				}
		

8. Validações

{
								"envelopeDocuments": [
								{
								"documentVersion": "abc",
								"envelopePosition": 1,
								"pdfTemplateId": "template-123"
								},
								{
								"documentVersion": "abc",
								"envelopePosition": 2
								}
								]
								}