Documentação

API OmniTicketz

Integre catracas, apps móveis, CRMs e outros sistemas com a API REST do OmniTicketz. Acesse vouchers, clientes, realize check-ins e receba webhooks em tempo real.

Autenticação

Configure sua API Key para começar

Vouchers

Sincronize ingressos vendidos

Check-in

Valide QR Codes e registre entradas

Playground

Teste a API direto no navegador

Base URL

Cada tenant possui sua própria URL base. A URL abaixo é detectada automaticamente:

https://sua-plataforma.com.br/api/v1

Formato de Requisição

Todas as requisições devem incluir o header X-API-Key com sua chave de API:

curl -X GET "https://sua-plataforma.com.br/api/v1/api-vouchers" \
  -H "X-API-Key: sk_live_SUA_CHAVE_AQUI" \
  -H "Content-Type: application/json"

Formato de Resposta

Todas as respostas seguem o formato JSON padrão:

{
  "success": true,
  "data": [...],
  "pagination": {
    "total": 100,
    "limit": 20,
    "offset": 0,
    "has_more": true
  }
}

Isolamento Multi-Tenant

Cada API Key só acessa dados do próprio tenant. Você nunca verá dados de outros clientes. O isolamento é garantido automaticamente em todas as requisições.

Endpoints Disponíveis

Método	Endpoint	Descrição
GET	/api-clientes	Lista clientes do tenant
GET	/api-vouchers	Lista vouchers/ingressos vendidos
POST	/api-qrcode-checkin	Consultar QR Code + check-in
PATCH	/api-qrcode-checkin	Estornar check-in

Autenticação