Comece por aqui

Esta é a documentação da API pública da Gandaya. Aqui você encontra tudo que precisa para integrar com nossos serviços e começar a consumir dados de pagamentos, eventos e mais.

URL Base

Todas as chamadas devem ser feitas para a URL base abaixo:

Autenticação

A API utiliza autenticação via API Key. Todas as requisições devem incluir o header X-API-Key com sua chave:

curl -X GET "https://api.gandaya.dance/public/v1/payments" \
  -H "X-API-Key: gd_a1b2c3d4_..."

Cada chave tem um conjunto de scopes que determinam quais rotas podem ser acessadas:

• data — leitura de dados (ex: GET /payments)
• validation — operações de validação (ex: check-in)

Cada rota documenta os scopes exigidos. Uma chave sem o scope necessário recebe 401.

Como conseguir sua Chave de API

As chaves de API são gerenciadas pelo painel administrativo da Gandaya. Para obter a sua:

1. Acesse o painel administrativo da sua organização
2. Vá em Configurações
3. Crie uma nova chave de API, selecionando os eventos autorizados

Cada chave está vinculada a uma organização e a um conjunto específico de eventos. Requisições que tentarem acessar dados de eventos não autorizados retornarão erro 403.

Formato de Resposta

Sucesso

As respostas de sucesso retornam o recurso diretamente, sem envelope:

{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 120,
    "hasMore": true
  }
}

Erro

Em caso de erro, a resposta segue o formato:

{
  "error": {
    "code": "API_KEY_INVALID",
    "message": "The provided API key is not valid"
  }
}

Os principais códigos de erro são:

Requisições que excederem o limite de taxa retornam 429 com { "message": "Too many requests. Try again later." } (sem campo code).

Headers Padrão

Todas as respostas incluem Cache-Control: no-store por padrão.

Valores Monetários

Os valores monetários são retornados como strings (ex: "149.99") para preservar precisão decimal.

Suporte

Em caso de dúvidas ou problemas com a integração, entre em contato com o time de engenharia da Gandaya.