Começando

Autenticação

A API OmniTicketz usa API Keys para autenticar requisições. Cada chave é vinculada a um tenant e possui permissões configuráveis.

1. Criar uma API Key

Acesse o painel administrativo do seu tenant, navegue até Integrações > API Keys e clique em Nova API Key. Configure um nome, descrição e selecione as permissões necessárias.

Chave mostrada apenas uma vez

A chave completa (sk_live_...) é exibida apenas no momento da criação. Copie e guarde em local seguro imediatamente.

2. Usar em Requisições

Inclua o header X-API-Key em todas as chamadas:

X-API-Key: sk_live_abc123def456...

Permissões Disponíveis

Cada API Key pode ter uma ou mais permissões. Configure apenas as necessárias para sua integração:

Parâmetro	Tipo	Padrão	Descrição
`vouchers:read`	permission	—	Listar vouchers/ingressos vendidos
`vouchers:sync`	permission	—	Marcar vouchers como sincronizados
`vouchers:checkin`	permission	—	Registrar check-in via QR Code
`clientes:read`	permission	—	Listar clientes do tenant
`all`	permission	—	Acesso total a todos os endpoints

Erros de Autenticação

Se a autenticação falhar, a API retorna um erro 401:

{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "API Key inválida ou desativada"
  }
}

Códigos de Erro de Auth

Parâmetro	Tipo	Padrão	Descrição
`MISSING_API_KEY`	401	—	Header X-API-Key não foi enviado
`INVALID_API_KEY`	401	—	API Key inválida, desativada ou expirada
`PERMISSION_DENIED`	401	—	API Key não tem permissão para este endpoint

Boas Práticas

Segurança

Nunca exponha API Keys no código-fonte (use variáveis de ambiente)
Configure apenas as permissões estritamente necessárias
Revogue chaves comprometidas imediatamente no painel
Use chaves diferentes para cada integração/sistema
Monitore o uso das chaves no log de auditoria

Introdução

Clientes