Documentação da API

Integre seu negócio lifestyle e eventos com a plataforma Swingular

Autenticação

Acesso seguro à API com OAuth 2.0 e chaves de API

Endpoints

API REST abrangente para eventos, perfis e muito mais

Documentação

Guias detalhados, exemplos e referências de SDK

Visão Geral da API

Como Começar

1. Cadastrar como Parceiro

Antes de acessar a API, você precisa se cadastrar como parceiro Swingular. Este processo é gratuito e lhe dá acesso ao nível básico da nossa API.

2. Gerar Chaves de API

Após o cadastro, você pode gerar chaves de API no seu painel de parceiro. Essas chaves são usadas para autenticar suas solicitações à API.

3. Fazer Solicitações à API

Use suas chaves de API para fazer solicitações aos nossos endpoints. Todas as solicitações devem ser feitas via HTTPS e incluir sua chave de API no cabeçalho.

Autenticação

Autenticação por Chave de API

Inclua sua chave de API no cabeçalho de Autorização das suas solicitações:

Authorization: Bearer YOUR_API_KEY

OAuth 2.0

Para aplicações que precisam acessar dados de usuários, use OAuth 2.0:

// Step 1: Redirect to authorization URL
https://api.swingular.com/oauth/authorize?
  client_id=YOUR_CLIENT_ID&
  redirect_uri=YOUR_REDIRECT_URI&
  response_type=code&
  scope=events.read,events.write

Limites de Taxa

Plano Básico

• 1,000 requests per day
• 60 requests per minute
• Cached responses for high-volume endpoints

Plano Premium

• 10,000 requests per day
• 300 requests per minute
• Priority access during high traffic
• Dedicated support for API integration

Endpoints da API

/events

Criar, ler, atualizar e excluir eventos. Filtrar por data, localização e tipo.

GET/events

Listar todos os eventos com paginação e filtragem

POST/events

Criar um novo evento

GET/events/{id}

Obter um evento específico por ID

PUT/events/{id}

Atualizar um evento existente

/business

Gerenciar seu perfil de negócio, horários, comodidades e fotos.

GET/business

Obter seu perfil de negócio

PUT/business

Atualizar seu perfil de negócio

POST/business/photos

Fazer upload de fotos do negócio

GET/business/reviews

Obter avaliações do seu negócio

/analytics

Acessar dados de analytics para seu negócio e eventos.

GET/analytics/events

Obter analytics dos seus eventos

GET/analytics/business

Obter analytics do seu perfil de negócio

GET/analytics/demographics

Obter dados demográficos dos seus visitantes

GET/analytics/reports

Gerar relatórios personalizados

Pronto para Integrar?

Comece hoje com nossa API e conecte seu negócio lifestyle a milhões de potenciais clientes.

Frequently Asked Questions

Quais linguagens de programação são suportadas?

Nossa API REST funciona com qualquer linguagem de programação que possa fazer solicitações HTTP. Disponibilizamos SDKs para JavaScript, Python, PHP e .NET, com mais linguagens em breve.

Existe um ambiente sandbox para testes?

Sim, disponibilizamos um ambiente sandbox completo com dados de teste que espelha nossa API de produção. Todos os parceiros têm acesso ao sandbox durante o processo de integração.

Quais são os limites de taxa da API?

Parceiros do plano básico têm 1.000 solicitações por dia e 60 por minuto. Parceiros premium têm 10.000 solicitações por dia e 300 por minuto. Planos empresariais oferecem limites personalizados.

Vocês oferecem notificações por webhook?

Sim, suportamos webhooks para notificações em tempo real sobre eventos como novos RSVPs, atualizações de eventos e alterações ao perfil de negócio. Os endpoints de webhook são configuráveis no seu painel de parceiro.

Como obtenho suporte durante a integração?

Todos os parceiros têm acesso à nossa equipe de suporte para desenvolvedores. Parceiros premium recebem suporte prioritário com especialistas de integração dedicados e tempos de resposta mais rápidos.