Antes de começar
Caso você nunca tenha feito integrações com o holmes recomendamos os seguintes passos:
Visualizando documento usando o Preview do Holmes
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}
Parâmetros 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
https://camo.githubusercontent.com/c5805dd0a6285e4b2bde34439f30c25b20ed228d/68747470733a2f2f692e696d6775722e636f6d2f486145655247362e6a7067