Usando a API da Passtastic
O que a API permite fazer
A API da Passtastic conecta seus próprios sistemas — um PDV personalizado, um CRM, um aplicativo interno — diretamente ao seu programa de fidelidade. Com ela você pode:
- Inscrever clientes e emitir cartões de wallet a partir do seu próprio fluxo de cadastro
- Adicionar carimbos ou pontos, e consultar o saldo de um cliente, direto do seu caixa ou back office
- Receber notificações em tempo real com webhooks — em vez de ficar consultando a API, a Passtastic envia um evento para o seu sistema no momento em que algo acontece (um cliente se inscreve, uma recompensa é resgatada, e mais)
Isso é para negócios que estão criando uma integração personalizada. Se você só quer uma conexão pronta, veja Conecte o Square POS ou Sistemas POS e integrações — sem escrever código.
O acesso à API depende do seu plano. Se não estiver incluído, você verá uma oferta de upgrade ao abrir API e webhooks em Configurações.
Crie uma chave de API
1. Abra Configurações, depois API e webhooks (em Negócio).
2. Na aba Chaves de API, clique em Criar chave.
3. Dê um nome à chave para saber depois para que serve (ex.: "CRM de produção").
4. Sua nova chave é mostrada uma única vez, na janela Sua nova chave de API. Copie agora — você não poderá vê-la novamente. Clique em Copiar, ou em Mostrar para revelá-la antes.
Trate essa chave como uma senha. Qualquer pessoa que a tenha pode agir na sua conta pela API.
5. Guarde a chave com segurança no seu próprio sistema (uma variável de ambiente, um gerenciador de segredos) e envie-a como cabeçalho de autenticação em cada requisição — o formato exato está na referência técnica abaixo.
Somente admins podem criar ou revogar chaves de API.
Perdeu uma chave ou acha que ela vazou?
As chaves não são mostradas novamente depois de criadas. Se você perdeu uma, ou acha que ela foi exposta, abra Chaves de API e clique em Revogar nela — isso a interrompe imediatamente — depois crie uma nova e atualize sua integração.
Configure um webhook
Webhooks fazem seu sistema reagir no momento em que algo acontece na Passtastic, sem que você precise ficar consultando a API.
1. Na aba Webhooks, clique em Adicionar endpoint.
2. Digite a URL do endpoint — o endereço no seu próprio sistema que vai receber o evento (ex.: `https://seu-sistema.com/hook`).
3. Em Eventos, escolha quais quer receber:
- Cliente inscrito
- Saldo atualizado
- Nível alterado
- Recompensa resgatada
4. Salve. Seu segredo de assinatura é mostrado uma única vez, na janela Segredo de assinatura — copie agora. Use-o para verificar se uma requisição de webhook realmente veio da Passtastic (a referência técnica explica como conferir a assinatura).
Somente admins podem criar ou editar webhooks.
Cada endpoint de webhook mostra suas entregas recentes, para você conferir se uma chamada teve sucesso ou falhou, e reenviar uma entrega que falhou assim que seu sistema voltar a funcionar, sem esperar pelo próximo evento.
Editar ou desativar um webhook
Abra o endpoint e clique em Editar para mudar a URL ou os eventos, ou defina o status como Desativado para pausar as entregas sem excluí-lo. Clique em Excluir para removê-lo definitivamente.
Onde encontrar a referência técnica completa
Este guia cobre a parte do painel — criar chaves e webhooks. Para endpoints, formatos de requisição/resposta, cabeçalhos de autenticação, códigos de erro e exemplos de código, veja a documentação da API completa. Você também pode acessá-la a qualquer momento pelo link Ler a documentação da API no topo da página API e webhooks.