v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

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.

post/api/files/upload/template

Request body

folderinteger

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

departmentsinteger[]

Departamento(s) o qual o documento deve pertencer.

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

Visibilidade padrão do documento.

namestring required

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

filestring binary required

[File/String Base64] Arquivo que está sendo enviado em PDF (File ou Base64), Word, Excel ou Power Point. (Para Base64 utilizar o formato data:application/pdf;base64)

pass_ownerstring

Senha do propietário do documento com permissões totais.

pass_userstring

Senha de acesso simples do documento.

optimizerboolean

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

uploaded_byinteger

ID do usuário que enviou o documento.

editablevalidateinteger

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

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "data": {
    "id": 182151,
    "name": "teste-template",
    "file_name": "lT5rX42RNCCoSXbv1X4KjQzVUSU7F8hx.pdf",
    "extension": "pdf",
    "size": 14639,
    "status": "Unsigned",
    "document_key": "lT5rX42RNCCoSXbv1X4KjQzVUSU7F8hx",
    "editted": "No",
    "is_template": "Yes",
    "template_fields": "[\"200\",{\"xPos\":\"10\",\"yPos\":\"30\",\"input\":\"image\",\"width\":\"200\",\"height\":\"120\",\"page\":\"2\"},{\"input\":\"text\",\"xPos\":\"122\",\"yPos\":\"324\",\"width\":\"200\",\"height\":\"120\",\"page\":\"3\",\"fontsize\":\"14\",\"text\":\"meu texto\",\"color\":\"#404034\"}]",
    "accessibility": "Departments",
    "folder": "Source",
    "uploaded_by": {
      "name": "Sua Empresa",
      "last_name": "Assinaturas"
    },
    "uploaded_on": "20/11/2023 19:56:41",
    "download": "https://app.plugsign.com.br/api/files/download/lT5rX42RNCCoSXbv1X4KjQzVUSU7F8hx"
  },
  "message": "Upload efetuado com sucesso!"
}