Realizando as chamadas via API
Como o seu sistema pode se integrar com a API Visitec
Daniel
Última atualização há 4 anos
Antes de começar: lembre que as chamadas via API são realizadas a partir do código fonte do sistema que deseja se integrar. Os passos aqui descritos serão diferentes dependendo da linguagem de programação que será utilizada.
A API Visitec é privada e protegida utilizando um padrão de mercado para autorização de segurança de APIs. Este padrão se chama oAuth2 e é possível encontrar bibliotecas para diversas linguagens como:
ClientID e ClientSecret
O primeiro passo para seu sistema conseguir realizar chamadas é liberar o acesso e obter um ClientID e ClientSecret. Para conseguir estes códigos você precisa entrar em contato com nosso suporte, informando o nome do seu sistema e que deseja iniciar a integração via API no servidor de testes.
Exemplo de ClientID e ClientSecret:
👉 Estes códigos são diferentes para o servidor de produção. Quando finalizar a integração e testá-la com sucesso no servidor de testes nós revisaremos a sua integração e você receberá os códigos de produção.
AccessToken
O próximo passo é conseguir um AccessToken. Este token é o que dá acesso à um usuário realizar as chamadas. Para conseguir esse token realize a seguinte chamada:
👩🏻💻 POST para /oauth/token com os parâmetros:
👉 Toda chamada via API é realizada em nome de um agente cadastrado no Visitec. Tudo o que for realizado via API será registrado em nome deste agente (no histórico, na timeline e nos logs de ações). Se não quiser usar o seu acesso pessoal, você pode ter um agente cadastrado somente para esse acesso via API.
Veja um exemplo de chamada usando o cURL:
Este é um exemplo de resposta com sucesso:
Realizando a chama da API GraphQL
Finalmente com o AccessToken é possível agora realizar uma chamada pra API GraphQL para realmente consultar algum dado ou executar alguma ação!
👉 GraphQL é um padrão de chamadas de API e tudo o que deseja fazer via API será utilizando este padrão, veja mais em: https://graphql.org
Toda request da API será:
👩🏻💻 POST para /graphql
Você precisa adicionar o AccessToken no header Authorization da request assim:
Veja um exemplo de uma request usando o cURL:
A resposta será o que solicitou na query:
👉 No parâmetro query você envia o tanto queries quanto mutation (as mesmas que você pode testar no GraphiQL)
👉 Veja como utilizar variáveis para a query aqui: https://graphql.org/learn/queries/#variables