Documentação da API

Integre o 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. Registar como Parceiro

Antes de poder aceder à API, precisa de se registar como parceiro Swingular. Este processo é gratuito e dá-lhe acesso ao nível básico da nossa API.

2. Gerar Chaves de API

Após o registo, pode gerar chaves de API a partir do seu painel de parceiro. Estas chaves são utilizadas para autenticar os seus pedidos à API.

3. Fazer Pedidos à API

Utilize as suas chaves de API para fazer pedidos aos nossos endpoints. Todos os pedidos devem ser feitos através de HTTPS e incluir a sua chave de API no cabeçalho.

Autenticação

Autenticação por Chave de API

Inclua a sua chave de API no cabeçalho de Autorização dos seus pedidos:

Authorization: Bearer YOUR_API_KEY

OAuth 2.0

Para aplicações que necessitam de aceder a dados de utilizadores, utilize 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, actualizar e eliminar 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}

Actualizar um evento existente

/business

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

GET/business

Obter o seu perfil de negócio

PUT/business

Actualizar o seu perfil de negócio

POST/business/photos

Carregar fotos do negócio

GET/business/reviews

Obter avaliações do seu negócio

/analytics

Aceder a dados de análise para o seu negócio e eventos.

GET/analytics/events

Obter análises dos seus eventos

GET/analytics/business

Obter análises 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 a nossa API e ligue o seu negócio lifestyle a milhões de potenciais clientes.

Frequently Asked Questions

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

A nossa API REST funciona com qualquer linguagem de programação que possa fazer pedidos 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 a 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?

Os parceiros do plano básico têm 1.000 pedidos por dia e 60 por minuto. Os parceiros premium têm 10.000 pedidos por dia e 300 por minuto. Os planos empresariais oferecem limites personalizados.

Disponibilizam notificações por webhook?

Sim, suportamos webhooks para notificações em tempo real sobre eventos como novos RSVPs, actualizaçõ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 equipa de suporte para programadores. Os parceiros premium recebem suporte prioritário com especialistas de integração dedicados e tempos de resposta mais rápidos.