API e integrações

API REST v1 com chaves de API

Cada academia cria as próprias chaves em Configurações → API e Webhooks. O recurso depende do plano da academia.

• Permissões por assunto: membros, acessos, produtos, pedidos, conteúdo e progresso
• E-mail, telefone e documento só aparecem com a permissão de dados pessoais
• Validade de 30, 90, 180 ou 365 dias (máximo de 365), criação pelo proprietário após confirmar com um código de uso único enviado por e-mail, IPs permitidos e revogação imediata
• Cadastro de membros e concessão ou remoção de acessos, com Idempotency-Key para repetir chamadas com segurança
• Pedidos e assinaturas são somente leitura
• Especificação OpenAPI em /api/v1/openapi.json

Webhooks de saída

A Academy avisa o seu sistema, em uma URL https sua, quando algo acontece.

• Venda aprovada, reembolso, chargeback, assinatura criada e assinatura cancelada
• Aluno matriculado, acesso removido e aula concluída
• Cada aviso é assinado (HMAC SHA-256), com janela de 5 minutos contra repetição
• Novas tentativas automáticas em caso de falha, com histórico e reenvio no painel

Outras formas de integrar

Caminhos que já existiam e continuam disponíveis.

• Checkout com link próprio por oferta, pronto para usar em qualquer página
• Webhooks de importação das principais plataformas para migração de alunos e vendas
• Integrações que você mesmo ativa na área de membros, como pixels de analytics
• Leitura de pedidos e extrato pela v1 legada, com o token do administrador

Para quem está migrando

Se você vende em outra plataforma, comece pela importação: traga alunos e histórico e use a sua marca desde o primeiro dia.