POST Upload 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.

Campos do template: informe width_page (largura da página em pixels) e fields[] com a posição de cada campo (input image para assinatura ou text para texto; page, width, height, xPos, yPos e, para text, text, color e fontsize). Sem esses campos o template é criado sem posições e POST /api/requests/templates responde 422 ("Este template não possui campos definidos").

Regras: formatos aceitos pdf, doc, docx, xls e xlsx; file como arquivo (multipart/form-data) ou base64 com data URI (apenas PDF); pass_owner e pass_user em par e não aceitos para Word; a resposta tem o mesmo formato de POST /api/files/upload (inclui tags, editablevalidate e pdf_optimization).

Tamanho dos documentos: size é um inteiro em KB decimais (1 KB = 1000 bytes), com mínimo de 1 KB para arquivo não vazio. Não confunda esse valor com os tamanhos em bytes da otimização de PDF e dos arquivos de relatório.

Envio de arquivos: use multipart/form-data ao transmitir arquivos binários. Nos endpoints que aceitam base64, o arquivo pode ser uma string no JSON. Certificados e imagens enviados como arquivo não devem ser serializados como texto JSON. Inclua Accept: application/json para receber erros de validação em JSON.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32

ID da pasta onde o documento deve ser armazenado. Caso não seja informado, o documento ficará na pasta raiz da empresa.

departments
array of int32s

Departamento(s) o qual o documento deve pertencer.

departments
string
enum

Visibilidade padrão do documento.

Allowed:
string
required

Nome único do documento para visualização no front-end.

file
required

Arquivo PDF, DOC, DOCX, XLS ou XLSX (multipart/form-data) ou string base64 com data URI (apenas PDF).

string

Senha do proprietário do PDF. Obrigatória quando pass_user é enviada; não aceita para Word.

string

Senha de abertura do PDF. Obrigatória quando pass_owner é enviada; não aceita para Word.

boolean

Marca o documento para otimização, caso enviado 1 o sistema irá otimizar e achatar campos de formulário no documento.

int32

ID do usuário que enviou o documento.

int32

Tipo de validação padrão ao assinar um documento.

7 - QR Code (Texto) na lateral direita.

6 - QR Code (Texto) na lateral esquerda.

5 - Página final de validação e QR Code no cabeçalho (Criaremos páginas extras).

4 - QR Code no rodapé do documento (Sem página final).

3 - Página final de validação e QR Code.

2 - Sem QR Code no topo, apenas página no final.

1 - QR Code no topo do documento (Sem página final).

Ao solicitar a assinatura na última página, sem posicioná-la, a página final será sempre gerada automaticamente

number

Largura da página em pixels usada para calcular as posições de fields[].

fields
array of objects

Campos do template (posições usadas nas solicitações enviadas com este template).

fields
Responses

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