v1

latestOpenAPI 3.1.02026-08-041060342.7 KB

POST Upload file

Com este endpoint você poderá enviar um novo arquivo ao sistema, para futuramente enviar para uma ou mais pessoas assinarem e/ou preencherem o mesmo. ATENÇÃO! O envio do documento e dos templates possuem finalidades diferentes! O upload de documentos é o envio simples de um arquivo, já o template precisa que no ato do envio, você defina seus campos de preenchimento e assinatura, para mais informações sobre os campos consulte a documentação dos templates ou de solicitações de assinaturas. Para envio de documentos é necessário que o tipo da requisição seja um form-data! Para enviar um documento para o sistema, você deverá passar alguns parâmetros conforme abaixo, porém destacamos aqui o parâmetro FILE. Este parâmetro poderá ser de dois tipos: Documento: Um documento nos formatos PDF, Word, Excel ou Power Point (Futuramente será necessário converte-los para PDF). Base 64: Um código base64 exclusivo para PDF, com o início "data:application/pdf;base64," Conversão para PDF: Quando um documento for assinado ou uma solicitação de assinatura for realizada, a conversão de documentos Office para PDF será feita automaticamente. As informações do documento como document_key não são alteradas, porém dados como o endpoint para download, o formato e o tamanho do mesmo serão ajustados.

post/api/files/upload

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

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.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "data": {
    "id": 182149,
    "name": "teste",
    "file_name": "dNknsDeLIc4rgcSyYTQ2QpIjWME5E0dA.pdf",
    "extension": "pdf",
    "size": 14639,
    "status": "Unsigned",
    "document_key": "dNknsDeLIc4rgcSyYTQ2QpIjWME5E0dA",
    "editted": "No",
    "is_template": "No",
    "accessibility": "Departments",
    "folder": "Source",
    "uploaded_by": {
      "name": "Assinatura",
      "last_name": "Assinaturas"
    },
    "uploaded_on": "20/11/2023 19:27:34",
    "download": "https://app.plugsign.com.br/api/files/download/dNknsDeLIc4rgcSyYTQ2QpIjWME5E0dA"
  },
  "message": "Upload efetuado com sucesso!"
}