logo

Mecanismo de autenticação da API

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

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 string.

Parâmetro Exemplo
accessToken aa001194-b02d-46a3-baaa-0ac59306238
clientId 514d5a2203ab5c78dbc017d1294904c8d3265eeb658

No exemplo abaixo, estamos solicitando o preview de um documento.

https://api.holmesdoc-homolog.com/preview/235100/page/0?accessToken=aa001194-b02d-46a3-baaa-0ac593062386&clientId=514d5a2203ab5c78dbc017d1294904c8d3265eeb658 

Se você ainda não possui um token de acesso, por favor contate nossa equipe.

Sobre as permissões

O accessToken está vinculado a um usuário do Holmes, portanto, sempre que for solicitado a geração de um novo token, também será criado um usuário específico de integração dentro do cliente. As permissões do token serão as mesmas permissões configuradas no usuário. Por exemplo, se um usuário integracao tem acesso apenas para visualizar as naturezas Nota Fiscal e Contas a pagar, o accessToken vinculado a este usuário só funcionará para os serviços que utilizem essas naturezas.

Caso seja necessário alterar alguma permissão, basta entrar no Admin do Holmes, localizar o usuário de integração e fazer as devidas modificações.

 

Caso você não saiba como obter o AccessToken e o ClientID faça uma solicitação enviando um email para suporte@redspark.io informando o nome da sua empresa no Holmes.

0 acharam interessante