Pular para o conteúdo principal

Introdução

A API Pública VoxFi permite que você interaja com a plataforma VoxFi programaticamente. Todos os endpoints requerem autenticação usando uma chave de API que você gera nas configurações da sua conta.

Obtenha Sua Chave de API

  1. Faça login na sua conta VoxFi
  2. Navegue até PerfilSegurança
  3. Gere uma nova chave de API
  4. Copie e armazene sua chave de API com segurança (você não poderá vê-la novamente)
Mantenha sua chave de API segura e nunca a compartilhe publicamente. Trate-a como uma senha.

URL Base

Todas as requisições à API devem ser feitas para:
https://data-api.voxfi.com.br/v1

Autenticação

Toda requisição à API deve incluir sua chave de API nos cabeçalhos da requisição:
X-Api-Key: sua-chave-de-api-aqui

Sua Primeira Requisição

Vamos começar buscando uma lista de eventos disponíveis:
curl -X GET "https://data-api.voxfi.com.br/v1/data/events" \
  -H "X-Api-Key: sua-chave-de-api-aqui"

Rate Limits

A API implementa rate limits para garantir uso justo. Informações sobre limites de taxa são retornadas nos cabeçalhos de resposta quando os limites são aproximados.

Próximos Passos