Começar

Começar em 5 minutos

Do zero ao primeiro evento: chave, participante, evento e o clube aberto.

O iClubing é um clube de fidelidade gamificado (níveis, check-in, missões, roleta, torneios, cashback e prêmios) que roda com a sua marca. O seu sistema só precisa contar o que aconteceu (um cadastro, um depósito, uma compra) e creditar os prêmios que o clube pedir. O resto — regras, telas e tempo real — é nosso.

1. Crie a chave de teste

No Studio, abra Técnico › Integrações › Chaves e crie uma chave secreta de teste (cf_test_…). Ela aparece uma vez só: guarde no seu servidor, como variável de ambiente. Nunca coloque a chave secreta no navegador ou no app.

2. Mande o primeiro evento

O participante é identificado pelo seu ID (o external_id: o id do usuário no seu sistema). Ele é criado sozinho no primeiro evento.

bash

curl -X POST https://api.iclubing.com/v1/events \
  -H "Authorization: Bearer $ICLUBING_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "dep_8891",
    "participant": "user_123",
    "type": "deposit.confirmed",
    "amount": 100
  }'

A resposta diz o que o evento causou (XP, moedas, missão, nível). Mandar o mesmo id de novo não conta duas vezes.

json

{
  "event_id": "evt_…",
  "duplicate": false,
  "effects": [
    { "type": "xp_granted", "amount": 500, "rule_id": "deposito" },
    { "type": "currency_granted", "currency": "coins", "amount": 20, "rule_id": "deposito" }
  ]
}

3. Abra o clube como esse participante

O seu servidor pede um token curto para o participante e o navegador abre o clube com ele:

bash

curl -X POST https://api.iclubing.com/v1/participants/user_123/token \
  -H "Authorization: Bearer $ICLUBING_KEY"
# → { "token": "eyJ…", "expires_at": "…", "participant_id": "part_…" }

text

https://clube.iclubing.com/SEU-CLUBE?token=eyJ…

Pronto: o participante vê o clube com o XP que ganhou. Daqui em diante, escolha como o clube aparece no seu produto em Instalação e ligue os prêmios em Webhooks e Entregas.

O caminho completo

Chave de API de teste no seu servidor.
Participante conectado: token para o clube abrir logado.
Eventos: cadastro, depósito, aposta, compra…
Webhook respondendo 2xx com assinatura verificada.
Entrega confirmada: você credita o prêmio e confirma.
Produção: chave cf_live_, webhook de produção e publicar.

O Studio mostra esses seis passos em Integrações e marca cada um sozinho quando ele acontece.