POST Upload file
Changed onCom este endpoint você poderá enviar um novo arquivo ao sistema, para futuramente enviar para uma ou mais pessoas assinarem e/ou preencherem o mesmo. <br><br> <b>ATENÇÃO! O envio do documento e dos templates possuem finalidades diferentes!</b> <br><br> 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. <br><br> <b>Para envio de documentos é necessário que o tipo da requisição seja um form-data!</b> <br><br> Para enviar um documento para o sistema, você deverá passar alguns parâmetros conforme abaixo, porém destacamos aqui o parâmetro FILE. <br><br> Este parâmetro poderá ser de dois tipos: <br><br> Documento: Um documento nos formatos PDF, Word, Excel ou Power Point (Futuramente será necessário converte-los para PDF). <br> Base 64: Um código base64 exclusivo para PDF, com o início "data:application/pdf;base64," <br><br> <b>Conversão para PDF:</b> Quando um documento for assinado ou uma solicitação de assinatura for realizada, a conversão de documentos Office para PDF será feita automaticamente. <br><br> 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.<p><strong>Regras:</strong></p><ul><li>Formatos aceitos: <code>pdf</code>, <code>doc</code>, <code>docx</code>, <code>xls</code> e <code>xlsx</code> (outros respondem 403). PowerPoint não é aceito.</li><li><code>file</code> pode ser enviado como arquivo (<code>multipart/form-data</code>) ou como string base64 com data URI (<code>data:application/pdf;base64,...</code>); em base64 use apenas PDF.</li><li><code>pass_owner</code> e <code>pass_user</code> precisam ser enviados juntos e não são aceitos para documentos Word.</li><li>Se já existir um documento com o mesmo nome e extensão na empresa, o nome recebe um sufixo: "nome (1)", "nome (2)"...</li><li><code>optimizer</code>: omitido, PDFs na versão 1.5 são otimizados automaticamente; <code>true</code> otimiza sempre; <code>false</code> nunca. O resultado vem em <code>pdf_optimization</code>.</li><li>O upload dispara o webhook <code>FILE_UPLOADED</code> e conta no uso mensal de arquivos; limites de disco/arquivos do plano respondem 403.</li></ul>
Request
- Base URLhttps://app.plugsign.com.br
- URLhttps://app.plugsign.com.br/api/files/upload
- AuthAPI key in header Authorization
Request body
Response
200
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",
"editablevalidate": 1
},
"message": "Upload efetuado com sucesso!"
}Changes
- info
added the non-success response with the status
- info
added the non-success response with the status
- info
added the optional property
/to the response with the status - info
added the optional property
/to the response with the status - info
added the optional property
to the response with the status
- info