logo

PARA DESENVOLVEDORES

Fazendo buscas com a API

Antes de começar Caso você nunca tenha feito integrações com o holmes recomendamos os seguintes passos: Veja o vídeo Holmes API Entenda o mecanismo de autenticação  Usando a API de Search GET /search Paramêtros (query string) Campo Descrição Tipo query Consulta string start Posição do primeiro registro int rows Total de registros int sortBy Campo de ordenação string order Tipo da ordenação enum (ASC ou DESC) Exemplos Procurar documentos que foram classificados com a natureza “Ponto” e que contenham as […]

Enviando documentos já classificados para o Holmes

Antes de começar Caso você nunca tenha feito integrações com o holmes recomendamos os seguintes passos: Veja o vídeo Holmes API Entenda o mecanismo de autenticação  API de upload com classificação Envia um documento para o Holmes e já faz sua classificação. POST (multipart/form-data) /upload Paramêtros Campo Descrição Tipo file Arquivo a ser enviado file natureId ID da natureza int thumbPage Página da miniatura int convert Se deve converter boolean notify Se deve notificar boolean <ID da propriedade> Este campo […]

Enviando documentos para o Holmes – Sem classificação

Antes de começar O tutorial abaixo demonstra como utilizar a API de download do Holmes. Caso você nunca tenha feito integrações com o holmes recomendamos os seguintes passos: Veja o vídeo Holmes API Entenda o mecanismo de autenticação  API de upload Envia um documento para o Holmes. POST (multipart/form-data) /upload Paramêtros Campo Descrição Tipo file Arquivo a ser enviado file thumbPage Página da miniatura int Exemplos Request Request URL: https://api.holmesdoc-homolog.com/upload Request Method: POST Request Content-type: multipart/form-data; boundary=—-WebKitFormBoundaryCE9f11X2wObf3I8R Request Payload: ——WebKitFormBoundaryCE9f11X2wObf3I8R […]

Visualizando documento usando o Preview do Holmes

Antes de começar Caso você nunca tenha feito integrações com o holmes recomendamos os seguintes passos: Veja o vídeo de Introdução a API do Holmes Entenda o mecanismo de autenticação  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 […]

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: Veja o vídeo de Introdução a API do Holmes 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 […]

Mecanismo de autenticação da API

Antes de começar Caso você nunca tenha feito integrações com o holmes recomendamos os seguintes passos: Veja o vídeo de Introdução a API do Holmes Autenticação por token Todo acesso a API do Holmes é realizado através de dois parâmetros, o accessToken e o clientId. Para cada cliente que deseja efetuar uma integração será gerado um clientId e um accessToken específico para ele. Estes parâmetros devem ser incluídos em todas as requisições feitas ao Holmes e podem ser enviados por header ou query […]

Dominando o HQL – Holmes Query Language

O HQL, Holmes Query Language, é uma notação proprietária da Plataforma Holmes que permite fazer consultas simples e avançadas em um poderoso motor de busca para grandes volumes de documentos. O campo como chave Uma instrução HQL é composta pelo conjunto chave:valor. A mais simples destas instruções ocorre quando a chave é o nome de um campo, previamente definido na área administrativa do Holmes, e o valor é o que se deseja procurar. Por exemplo, dado que foi definido na administração […]

Introdução a API do Holmes

Muitos sistemas são construídos com algumas premissas técnicas em mente e em algum ponto no futuro precisam disponibilizar recursos via Web Services (REST ou SOAP). Esta especie de adaptação posterior tende a gerar efeitos colaterais que implicam em complexidade ou perda da performance. Por outro lado, quando o sistema é construído em cima de uma verdadeira Arquitetura Orientada a Serviços o resultado são APIs simples, leves e flexíveis como é o caso da Plataforma Holmes. O vídeo abaixo apresenta tudo […]