Como Requisitar Dados do v-tracker via API: Um Guia Passo a Passo

O v-tracker é uma plataforma completa que oferece recursos avançados de rastreamento e monitoramento de dados.

Para acessar e utilizar os dados coletados pelo v-tracker de maneira programática, você pode fazer uso da API fornecida. Neste guia, vamos detalhar o processo passo a passo para requisitar os dados através da API do v-tracker. Para requisitar os dados coletados pelo v-tracker via API, siga o passo a passo.

Por favor, lembre-se de substituir os colchetes “{}” nas URLs disponíveis pelo ID correspondente solicitado.

Gerar o Token de Acesso 

1. Gerar o Token de Acesso

O primeiro passo é gerar o token de acesso do seu usuário no v-tracker. Para isso, siga as instruções abaixo:

Acesse o painel “Meu Perfil” na plataforma.

Dentro do painel, localize a opção "Acesso a API" e clique sobre o botão "Gerar".

Esse token será o seu meio de autenticação para fazer as requisições na API.

Esse será o seu Token de acesso e você irá utilizá-lo para fazer as requisições na API.

2. Requisitando os Dados via API

Agora que você possui o token de acesso, siga os passos abaixo para requisitar os dados desejados:

Acesse a documentação da API do v-tracker, onde você encontrará todos os Endpoints disponíveis e as instruções detalhadas para realizar as requisições.

• https://api2.vtracker.com.br/api-doc/index.html
  

Ocorrências:

Para requisitar os conteúdos das ocorrências coletadas, siga estes passos:

Passo a passo para buscar os dados:

1 - Ter a chave de acesso/key gerada.

• Endpoint: /monitoramentos/listar

https://developers.vtracker.com.br/api/rest/monitoramentos/listar?key={chave}

2 -Liste os monitoramentos disponíveis para buscar as ocorrências.

• Endpoint: /monitoramentos/{id}/buscas
• https://developers.vtracker.com.br/api/rest/monitoramentos/{id}/buscas?key={chave}

3 - Liste as ocorrências do monitoramento informado, utilizando parâmetros como datas, sinceId e data de última atualização.

• Endpoint: /ocorrencias/listar
• https://developers.vtracker.com.br/api/rest/ocorrencias/recuperar?key={chave}&monitoramentoId={monitoramento_id}&ocorrenciaId={ocorrencia_id}

*Há outros Endpoints, aqui indicamos apenas o mais utilizado.

Tickets:

Passo a passo para usar a API dos Tickets:

1 - Ter a chave de acesso/key gerada.

2 - Liste os níveis disponíveis para buscar os tickets.

• EndPoint: /niveis/listar
• https://developers.vtracker.com.br/api/rest/niveis/listar?key={chave}

3 - Liste os tickets do nível informado, utilizando sinceId, data de última atualização.

• EndPoint: /tickets/listar
• https://developers.vtracker.com.br/api/rest/tickets/listar?key={chave}&nivelId={nivelId}sinceId={ticketId}

*Há outros Endpoints, aqui indicamos apenas o mais utilizado.

Dashboard:

Para fazer a chamada do Dashboard  é necessário salvar o filtro na listagem de ocorrências.

• Nesse artigo você encontra como salvar um filtro na listagem de ocorrências:
  https://blog.vtracker.com.br/v-tracker/filtros-de-busca

Após salvar o filtro, inicie a requisição do Dashboard

Passo a passo para usar a API de Dashboard:

1 - Ter a chave de acesso/key gerada.

2 - Liste os monitoramentos disponíveis para a criação do Dashboard.

• EndPoint: /monitoramentos/listar
• https://developers.vtracker.com.br/api/rest/monitoramentos/listar?key={chave}

3 - Liste os filtros que o monitoramento possui, pois será a partir desses filtros que o Dashboard será criado / atualizado.

• Endpoint: /filtros/listar
• https://developers.vtracker.com.br/api/rest/filtros/listar?key={chave}&monitoramentoId={monitoramentoId}

4 - Gere o Dashboard (será atualizado automaticamente, então não terá necessidade de recriá-lo, somente chamar de tempo em tempo o endpoint do próximo passo).

Caso não tenha conseguido copiar a chave, aguarde alguns minutos e gere novamente.

• Endpoint: /graficos/gerarDash
• http://developers.vtracker.com.br/api/rest/graficos/gerarDash?key={chave}&monitoramentoId={monitoramentoId}&filtroId={filtroId}

5 - Consultar os gráficos do Dashboard.

• Endpoint: /graficos/dados
• http://developers.vtracker.com.br/api/rest/graficos/dados?key={chave}&codigo={dash_id}&tipo={tipo}

Para visualizar os {Tipo} de gráficos, acesse a documentação da API e clique sobre Parâmetros disponíveis > Tipos de Dados Dashboard

_________________________________________________________________________

Lembre-se de substituir os colchetes “{}” nas URLs disponíveis pelo ID correspondente solicitado.

Dúvidas?

Se tiver dúvidas, você pode usar o seu navegador para testar a URL que faz a requisição na API. Monte a URL de acordo com as instruções acima e execute-a no navegador.

Este guia fornece uma visão geral dos passos necessários para requisitar dados do v-tracker via API.