API Reference
  1. PlugSign Documentation
  2. Lotes

POST Create lote

post
https://app.plugsign.com.br/api/lotes

Com este método é possível criar um lote de documentos com 2 a 50 arquivos. Com o uso de lotes, você agrupa documentos e cria uma solicitação de lote (lote request) para enviá-los todos de uma só vez, otimizando o processo de coleta de assinaturas.

A API cria uma pasta com o nome do lote dentro da pasta indicada em folder_id (ou na raiz) e armazena os documentos nela. Se já existir uma pasta com o mesmo nome, o nome recebe um sufixo numérico, por exemplo Contratos (2). Arquivos Word (DOC/DOCX) são convertidos para PDF.

A resposta é 201 Created com o lote e os documentos criados.

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

Nome do lote a ser cadastrado

file
array of strings
required

Lista com no mínimo 2 e no máximo 50 arquivos. Cada item pode ser um upload (multipart/form-data) ou uma string Base64 no formato data URI: data:application/pdf;base64,..., data:application/msword;base64,... ou data:application/vnd.openxmlformats-officedocument.wordprocessingml.document;base64,.... Formatos aceitos: PDF, DOC e DOCX. O nome de cada documento vem do parâmetro name do data URI (ex.: data:application/pdf;name=contrato.pdf;base64,...); sem ele a API gera um identificador aleatório como nome.

file*
departments
array of int32s

Departamento(s) o qual o documento deve pertencer

departments
string
enum

Visibilidade da pasta e dos documentos do lote. Padrão: Everyone.

Allowed:
int32

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.

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

3 - 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).

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

6 - QR Code (Texto) na lateral esquerda.

7 - QR Code (Texto) na lateral direita.

boolean

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

integer

ID da pasta-mãe onde a pasta do lote será criada. Use 1 para a raiz. A pasta precisa pertencer à sua empresa; caso contrário a resposta é 422.

integer

ID do usuário da empresa que ficará registrado como responsável pelo envio dos documentos. Se omitido, usa o usuário do token.

Responses

Updated 2 months ago

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

Updated 2 months ago

Did this page help you?