holmes-download.md

API de Download

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

holmes-preview.md

API de Preview

Para visualizar um documento dentro do Holmes será necessário utilizar a API de preview. Quando um upload é feito, o arquivo passa por um processo de conversão (assíncrona) e após sua conclusão um preview é disponibilizado.

GET /preview/{documentVersionId}/page/{pageNumber}

Paramêtros de entrada (URL)

Campo	Descrição	Tipo
documentVersionId	ID da versão do documento	number
pageNumber	Número da página (começa em 0)	number

Resposta

Código HTTP	Descrição
200	Sucesso (retorna uma imagem)
404	Documento não encontrado ou preview não está pronto

Exemplos

Request

https://api.holmesdoc-homolog.com/preview/29246197/page/0

Response