PLplugsign

POST Create lote

Changed on

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.

post/api/lotes

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/lotes
  • Auth
    API key in header Authorization

Request body

namestring required

Nome do lote a ser cadastrado

filestring[] required

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

departmentsinteger[]

Departamento(s) o qual o documento deve pertencer

accessibility'Everyone' | 'Departments' | 'OnlyMe'

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

editablevalidateinteger

1 - QR Code no topo do documento (Sem página final). <br><br> Ao solicitar a assinatura na última página, sem posicioná-la, a página final será sempre gerada automaticamente. <br><br> 2 - Sem QR Code no topo, apenas página no final. <br><br> 3 - Página final de validação e QR Code no cabeçalho (Criaremos páginas extras). <br><br> 4 - QR Code no rodapé do documento (Sem página final). <br><br> 5 - Página final de validação e QR Code no rodapé (Criaremos páginas extras). <br><br> 6 - QR Code (Texto) na lateral esquerda. <br><br> 7 - QR Code (Texto) na lateral direita. <br><br>

optimizerboolean

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

folder_idinteger

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.

senderinteger

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

Response

Lote criado

Example response

{
  "data": {
    "id": 10,
    "company_id": 1,
    "name": "lote_1",
    "created_at": "2024-07-12 14:24:11",
    "updated_at": "2024-07-12 14:24:11",
    "files": [
      {
        "id": 101168,
        "name": "lote_1-1",
        "file_name": "V9kAvLtOfyk2iqe3azv5684OdfRzqLbR.pdf",
        "extension": "pdf",
        "size": 13,
        "status": "Unsigned",
        "document_key": "V9kAvLtOfyk2iqe3azv5684OdfRzqLbR",
        "editted": "No",
        "is_template": "No",
        "accessibility": "Everyone",
        "uploaded_by": {
          "name": "Exemplo",
          "last_name": "Exemplo"
        },
        "uploaded_on": "14/07/2024 14:24:12",
        "download": "https://app.plugsign.com.br/api/files/download/V9kAvLtOfyk2iqe3azv5684OdfRzqLbR"
      }
    ]
  }
}

Changes

  • 3db1513040eaRevision changes
    • breaking

      removed the success response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status