Pular para o conteúdo principal

API Pública do Organizador

A API Pública permite que você integre seu site institucional, aplicativo ou sistema externo diretamente à sua conta de produtor para consultar eventos, lotes de ingressos, programação/atividades e perfil do produtor.

Autenticação Obrigatória

Todos os endpoints sob /api/v1/ exigem autenticação via API Key. Requisições sem chave, com chave inválida ou revogada retornam 401 Unauthorized.


1. Como gerar sua Chave de API​

  1. Acesse o painel do Organizador.
  2. Vá em Configurações → Chaves de API.
  3. Informe um nome identificador (ex.: Site Principal) e clique em Gerar nova chave.
  4. Copie a chave imediatamente (rc_live_...). Por segurança, ela é armazenada apenas em formato hash (SHA-256) e não pode ser visualizada novamente após sair da tela.
  5. Caso uma chave seja comprometida, clique em Revogar na mesma tela para bloqueá-la imediatamente.

2. Autenticação e Segurança​

Envie sua chave em todas as requisições usando um dos headers abaixo:

X-API-Key: rc_live_sua_chave_aqui

ou

Authorization: Bearer rc_live_sua_chave_aqui
Boas práticas
  • Nunca exponha sua API Key no JavaScript do navegador (client-side), pois ela dá acesso inclusive a eventos em rascunho (status=draft). Faça as chamadas no backend/SSR do seu site (Next.js Server Components, Route Handlers, Node.js, PHP, Python, etc.).
  • Se precisar chamar a API diretamente de outro domínio no navegador, adicione a origem na variável de ambiente ALLOWED_ORIGINS do backend.

3. Base URL​

Todas as rotas da API Pública ficam sob o prefixo /api/v1 do seu servidor backend:

https://seu-backend.exemplo.com/api/v1

4. Endpoints​

GET /api/v1/producer​

Retorna os dados do perfil público do produtor vinculado à chave de API.

Exemplo de requisição​

curl -X GET "https://seu-backend.exemplo.com/api/v1/producer" \
-H "X-API-Key: rc_live_sua_chave_aqui"

Resposta (200 OK)​

{
"slug": "roda-de-cuia",
"name": "Roda de Cuia Eventos",
"website": "https://rodadecuia.com.br",
"whatsapp": "+5551999999999",
"email": "[email protected]",
"cover_url": "https://...",
"logo_url": "https://...",
"description": "<p>Produtora cultural...</p>"
}

(Retorna 404 Not Found caso o produtor ainda não tenha salvo o Perfil Público em Configurações.)


GET /api/v1/events​

Lista os eventos cadastrados na conta do organizador autenticado.

Parâmetros de query (opcionais)​

ParâmetroTipoPadrãoDescrição
statusstringpublishedFiltra por status: published, draft ou all.
upcomingbooleanfalseQuando true, retorna apenas eventos com data igual ou posterior ao momento atual.
limitinteger50Quantidade máxima de itens por página (1 a 100).
offsetinteger0Deslocamento para paginação (>= 0).

Exemplo de requisição​

curl -X GET "https://seu-backend.exemplo.com/api/v1/events?status=published&upcoming=true&limit=20" \
-H "X-API-Key: rc_live_sua_chave_aqui"

Resposta (200 OK)​

{
"events": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"title": "Festival de Música 2026",
"description": "Descrição do evento...",
"date": "2026-12-10T22:00:00Z",
"location": "Parque Harmonia - Porto Alegre/RS",
"banner_url": "https://...",
"status": "published",
"allow_installments": true,
"accepted_payment_methods": ["PIX", "CREDIT_CARD"],
"created_at": "2026-11-01T14:00:00Z",
"updated_at": "2026-11-10T09:30:00Z"
}
],
"total": 1,
"limit": 20,
"offset": 0
}

GET /api/v1/events/{id}​

Retorna os detalhes completos de um evento específico pertencente ao organizador autenticado, incluindo lotes de ingressos e programação/atividades.

Exemplo de requisição​

curl -X GET "https://seu-backend.exemplo.com/api/v1/events/550e8400-e29b-41d4-a716-446655440000" \
-H "X-API-Key: rc_live_sua_chave_aqui"

Resposta (200 OK)​

{
"event": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"title": "Festival de Música 2026",
"description": "Descrição do evento...",
"date": "2026-12-10T22:00:00Z",
"location": "Parque Harmonia - Porto Alegre/RS",
"banner_url": "https://...",
"status": "published",
"allow_installments": true,
"accepted_payment_methods": ["PIX", "CREDIT_CARD"],
"created_at": "2026-11-01T14:00:00Z",
"updated_at": "2026-11-10T09:30:00Z"
},
"tickets": [
{
"id": "a1b2c3d4-...",
"name": "Pista - 1º Lote",
"description": "Acesso à área geral",
"price": 120.0,
"total_quantity": 500,
"available_quantity": 342,
"ticket_type": "PAID",
"max_per_purchase": 5,
"sales_start_date": "2026-11-01T00:00:00Z",
"sales_end_date": "2026-12-10T21:00:00Z"
}
],
"activities": [
{
"id": "f9e8d7c6-...",
"title": "Show de Abertura",
"description": "Palco Principal",
"location": "Palco A",
"price": 0,
"starts_at": "2026-12-10T22:00:00Z",
"ends_at": "2026-12-10T23:30:00Z",
"ticket_ids": ["a1b2c3d4-..."]
}
]
}

GET /api/v1/events/{id}/tickets​

Retorna apenas a lista de lotes/ingressos de um evento do organizador autenticado.

Resposta (200 OK)​

{
"event_id": "550e8400-e29b-41d4-a716-446655440000",
"tickets": [
{
"id": "a1b2c3d4-...",
"name": "Pista - 1º Lote",
"description": "Acesso à área geral",
"price": 120.0,
"total_quantity": 500,
"available_quantity": 342,
"ticket_type": "PAID",
"max_per_purchase": 5
}
]
}

5. Exemplo em Node.js / Next.js (Server-Side)​

const res = await fetch(`${process.env.ERP_API_URL}/api/v1/events?status=published&upcoming=true`, {
headers: {
"X-API-Key": process.env.ERP_PRODUCER_API_KEY!,
},
next: { revalidate: 60 },
});

if (!res.ok) {
throw new Error(`Erro na API: ${res.status}`);
}

const { events } = await res.json();

6. Códigos de Erro​

HTTP StatusCódigo (error)Motivo
400invalid_argumentParâmetro de query ou UUID de evento inválido.
401unauthorizedAPI Key ausente, inválida ou revogada.
404not_foundEvento, perfil ou rota não encontrada (ou pertence a outro organizador).
405method_not_allowedMétodo HTTP diferente de GET.
500internal_errorErro interno inesperado no servidor.