Começar
Conceitos
Clube, participante, evento, efeito, moeda, prêmio, entrega e ambientes.
| Termo | O que é |
|---|---|
| Clube | O programa com a sua marca. Tem regras, módulos (check-in, roleta…), prêmios e textos. Você edita no Studio e publica uma versão. |
| Participante | Um usuário seu dentro do clube, identificado pelo seu ID (external_id). Nunca precisamos de CPF, nome ou e-mail para funcionar. |
| Evento | Um fato que o seu sistema conta: deposit.confirmed, bet.placed, order.paid… Cada evento passa pelas regras do clube. |
| Efeito | O que um evento causou: XP, moedas, missão que andou, nível novo, prêmio. Volta na resposta do evento. |
| XP e nível | XP acumula e sobe o participante de nível. Níveis são agrupados em elos (Bronze, Prata…) com benefícios. |
| Moeda | Saldo que o participante gasta na loja (ex.: Coins). Pode expirar. |
| Prêmio | O que o participante ganha. internal: fica no clube. client_delivered: o seu sistema credita (bônus, giros, saldo) e confirma. |
| Entrega | O pedido para você creditar um prêmio client_delivered. Chega por webhook e você confirma na API. |
| Ambiente | test e live são separados: participantes, saldos, chaves e webhooks de teste nunca se misturam com os de produção. |
Três jeitos de usar
| Jeito | Como | Para quem |
|---|---|---|
| Clube hospedado | Um link (ou iframe) com o token do participante. | Quem não quer escrever tela. |
| Embed | Script ou SDK: o clube dentro do seu site/app em página, gaveta ou botão flutuante. | Quem quer o clube dentro do produto. |
| Headless | Só API: você desenha a própria tela e age pelo servidor. | Quem quer controle total da UI. |
Os três usam os mesmos eventos e as mesmas entregas. Dá para combinar: clube hospedado para tudo e, por exemplo, o saldo de cashback desenhado na sua própria tela pelo modo servidor.