Aprenda passo a passo como autenticar, acessar endpoints e recuperar dados usando a API do v-tracker.
Neste guia, iremos apresentar um procedimento detalhado, passo a passo, para que você possa requisitar os dados via API do v-tracker!
Como gerar o token de acesso?
1. Acesse o painel Meu Perfil na plataforma:
2. 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:
Como requisitar os dados?
Acesse a documentação da API do v-tracker, que contém uma lista completa de todos os Endpoints disponíveis, além de orientações detalhadas para a execução das requisições: https://api2.vtracker.com.br/api-doc/index.html.
Ocorrências
Para requisitar os dados das ocorrências coletadas, siga os passos abaixo:
1. Obtenha a chave de acesso: Primeiramente, certifique-se de ter gerado sua chave de acesso (key):
Endpoint: /monitoramentos/listar
URL: https://developers.vtracker.com.br/api/rest/monitoramentos/listar?key={chave}
Certifique-se de substituir os colchetes “{}” nas URLs fornecidas pelos IDs correspondentes que você deseja utilizar.
2. Liste os monitoramentos disponíveis: Utilize a chave de acesso para listar os monitoramentos que permitem a busca de ocorrências.
Endpoint: /monitoramentos/{id}/buscas
URL: https://developers.vtracker.com.br/api/rest/monitoramentos/{id}/buscas?key={chave}
3. Recupere as ocorrências: Com o ID do monitoramento escolhido, você pode listar as ocorrências, aplicando parâmetros como datas, sinceId e a data da última atualização.
Endpoint: /ocorrencias/listar
Cada chamada à API retorna um máximo de 200 itens, correspondendo a 200 ocorrências. Caso o período consultado contenha mais de 200 ocorrências, é necessário utilizar o filtro "SinceId" ou o parâmetro "proximaPagina" para acessar os resultados adicionais. Vale ressaltar que não é possível recuperar mais de 200 itens em uma única chamada.
- Exemplo onde foram requisitadas todas as páginas:
"sinceId": "20065389",
"proximaPagina": null
} - Exemplo da API contendo mais dados:
],
"sinceId": "22154982",
"proximaPagina": "/ocorrencias/listar?sinceId={sinceId}&dataInicio=[dataincio}&monitoramentoId={id}&key={key}
}
Tickets
Passo a passo para utilizar a API de Tickets:
1. Gerar a chave de acesso: Certifique-se de que você já possui sua chave de acesso (key) gerada.
2. Listar níveis de tickets: Utilize a chave de acesso para consultar os níveis disponíveis para busca de tickets.
Endpoint: /niveis/listar
URL: https://developers.vtracker.com.br/api/rest/niveis/listar?key={chave}
Certifique-se de substituir os colchetes “{}” nas URLs fornecidas pelos IDs correspondentes que você deseja utilizar.
3. Consultar tickets por nível: Com o nível desejado em mãos, você pode listar os tickets correspondentes, aplicando parâmetros como sinceId e a data da última atualização.
Endpoint: /tickets/listar
Além dos Endpoints mencionados, há outros disponíveis na API. Contudo, aqui focamos nos mais utilizados.
É importante ressaltar que o limite de 200 itens por chamada também se aplica a essas requisições. Para mais detalhes, consulte as informações específicas clicando aqui.
Dash
Para realizar a chamada do Dashboard, é essencial que você salve um filtro na listagem de ocorrências. Para orientações sobre como salvar um filtro, consulte o seguinte artigo: https://blog.vtracker.com.br/v-tracker/filtros-de-busca.
Após salvar o filtro, você pode proceder com a requisição do Dashboard. Abaixo, apresentamos um passo a passo para utilizar a API do Dashboard:
1. Certifique-se de que a chave de acesso (key) já foi gerada.
2. Liste os monitoramentos disponíveis que permitirão a criação do Dashboard.
Endpoint: /monitoramentos/listar
URL: https://developers.vtracker.com.br/api/rest/monitoramentos/listar?key={chave}
Certifique-se de substituir os colchetes “{}” nas URLs fornecidas pelos IDs correspondentes que você deseja utilizar.
3. Verifique os filtros associados ao monitoramento escolhido, pois esses filtros serão utilizados para criar ou atualizar o Dashboard.
Endpoint: /filtros/listar
4. Gere o Dashboard. Este será atualizado automaticamente, o que significa que não será necessário recriá-lo; basta chamar periodicamente o próximo endpoint.
Se você não conseguir copiar a chave, aguarde alguns minutos e gere-a novamente.
Endpoint: /graficos/gerarDash
5. Por fim, consulte os gráficos do Dashboard.
Endpoint: /graficos/dados
URL: http://developers.vtracker.com.br/api/rest/graficos/dados?key={chave}&codigo={dash_id}&tipo={tipo}
Para explorar os diferentes tipos de gráficos disponíveis, consulte a documentação da API e navegue até a seção Parâmetros disponíveis, onde você encontrará informações detalhadas sobre os Tipos de Dados do Dashboard:
Caso tenha alguma dúvida, você pode testar a URL da requisição da API diretamente no seu navegador. Para isso, construa a URL seguindo as orientações fornecidas anteriormente e, em seguida, execute-a no navegador para verificar os resultados.
Meu Consumo
1. Certifique-se de que a chave de acesso (key) foi gerada com sucesso.
2. Realize a consulta para verificar o consumo da empresa:
URL: https://developers.vtracker.com.br/api/rest/meuConsumo?key={chave}