API Reference

Download de documento

Para que serve?

Serve para realizar o download do documento.

Quando usar?

Esse serviço geralmente é utilizado para fazer o download, como:

  • Visualizar o documento;
  • Editar documento.

Como usar?

Na chamada do serviço é preciso passar o código do documento (documentId) e a identificação do arquivo (fileUniqueId) na plataforma.

Esse serviço deve ser executado pelo usuário que tenha permissão ao tipo de documento (templateId).

A identificação do arquivo (fileUniqueId) é correspondente a uma única versão do documento existente na plataforma. Logo, caso necessite realizar o download de uma versão específica é necessário saber o fileUniqueId correspondente a ela, que pode ser consultado a partir do serviço Obter versões de um documento.

Para consultar todos os detalhes, utilize o link abaixo para acessar a documentação técnica.

Link da APIs

VersõesLinkRelease InicialRelease FinalStatus
V1Documentação Técnica5.70 RTM 1.00🟢

🟢 API Disponível
🟡 API Depreciada
🔴 API Descontinuada