logo

Usando a API para download de documentos

Antes de começar

Caso você nunca tenha feito integrações com o holmes recomendamos os seguintes passos:

  1. Veja o vídeo de Introdução a API do Holmes
  2. Entenda o mecanismo de autenticação 

Para baixar um arquivo que esteja no Holmes será necessário utilizar a API de download. O arquivo retornado será o original, o mesmo que foi enviado no upload. É possível fazer o download de um arquivo só ou vários na mesma chamada de API.

GET /download/?versionId={documentVersionId}

Paramêtros (query string)

Campo Descrição Tipo
versionId ID da versão do documento number
  • Este parâmetro pode ser passado várias vezes sendo concatenado com o sinal &. Por exemplo: /download/?versionId=123&versionId=456

Resposta

Código HTTP Descrição
200 Sucesso. Retorna o arquivo para download com o nome original ou holmes-files.zip em caso de download múltiplo
403 Download não autorizado

Exemplos

Request

https://api.holmesdoc-homolog.com/download?versionId=29246198&versionId=29246197
0 acharam interessante