Academia — referência de regras
Para consultar, não para ler de ponta a ponta. Se você está tentando fazer alguma coisa, comece pelos guias: matricular, liberar a entrada, falar com o aluno, prescrever, captar.
Quem pode o quê
| Ação | Admin | Recepção | Professor | Nutricionista | Aluno |
|---|---|---|---|---|---|
| Cadastrar academia | Super Admin | — | — | — | — |
| Cadastrar equipe | Sim | — | — | — | — |
| Matricular aluno | Sim | Sim | — | — | — |
| Criar plano e definir preço | Sim | — | — | — | — |
| Matricular em plano | Sim | Sim | — | — | — |
| Reajustar contrato | Sim | — | — | — | — |
| Cancelar contrato | Sim | — | — | — | — |
| Encerrar contrato | Sim | Sim | — | — | — |
| Configurar recebimento | Sim | — | — | — | — |
| Liberar entrada | Sim | Sim | — | — | — |
| Ver frequência | Sim | Sim | Sim | — | Só a própria |
| Ver restrição clínica | Sim | Não | Sim | Sim | — |
| Prescrever treino | Sim | — | Sim | Não | — |
| Prescrever dieta | Sim | — | Não | Sim | — |
| Ler treino | Sim | — | Sim | Não | Só o próprio |
| Ler dieta | Sim | — | Não | Sim | Só o próprio |
| Escrever mensagem da academia | Sim | — | — | — | — |
| Atender aluno | Sim | Sim | — | — | — |
| Trabalhar o funil | Sim | Sim | — | — | — |
| Criar campos do cadastro | Sim | — | — | — | — |
| Editar o site | Sim | — | — | — | — |
| Configurar catraca | Sim | — | — | — | — |
| Ver estado das catracas | Sim | Sim | — | — | — |
| Capturar biometria | Sim | Sim | — | — | — |
| Cancelar débito automático | Sim | Sim | — | — | Sim |
O professor não lê dieta e o nutricionista não lê treino. Não é hierarquia, é finalidade: o professor precisa saber da lesão no ombro para montar a ficha; não precisa saber que o aluno tem intolerância a lactose.
Quem não alcança um dado não vê o menu dele. A navegação vem do servidor.
Regras de entrada
Conferidas nesta ordem. A primeira que falha é a que aparece.
| # | Regra | Motivo mostrado | Recepção libera? |
|---|---|---|---|
| 1 | Tem contrato? | Sem contrato ativo | Sim |
| 2 | Contrato trancado? | Contrato trancado | Sim |
| 3 | Contrato encerrado ou cancelado? | Contrato encerrado | Sim |
| 4 | Está inadimplente? | Pagamento em atraso | Sim |
| 5 | Atestado em dia? | Atestado vencido ou ausente | Não |
| 6 | O plano cobre este horário? | Fora do horário do plano | Sim |
| 7 | Bateu o limite semanal? | Limite de acessos da semana | Sim |
- A ordem importa: quem não tem contrato não deve ouvir "atestado vencido".
- O atestado é o único não liberável: todas as outras regras existem por dinheiro ou combinação comercial; essa existe por segurança física.
- A semana começa na segunda. Com semana no domingo, quem treina sábado e domingo gastaria acessos de semanas diferentes.
- Ninguém é barrado na saída. Barrar na saída prende a pessoa dentro.
Liberação manual
Exige justificativa, sempre. A negativa original não é apagada: a liberação vira uma linha nova, com o motivo contornado, a justificativa e quem liberou.
Regras de contrato
| Situação | O que significa | Gera cobrança | Entra na academia |
|---|---|---|---|
| Ativo | Em dia | Sim | Sim |
| Trancado | Pausa combinada | Não | Não |
| Inadimplente | Devendo, ainda matriculado | Sim | Não |
| Cancelado | Quebra de contrato | Não | Não |
| Encerrado | Vigência cumprida | Não | Não |
- Um aluno tem um contrato em vigor por vez.
- Trancar só funciona se o plano permitir — é opção de cada plano.
- Cancelar aciona a multa; encerrar não. Por isso cancelar é da administração e encerrar a recepção também faz.
- Sair de vigor cancela o débito automático no gateway. Trancar, cancelar e encerrar passam pelo mesmo ponto — senão o ex-aluno continua sendo cobrado.
Preço
- O contrato congela o valor no dia da matrícula. Mudar o preço do plano nunca muda o que os alunos atuais pagam.
- Valor diferente do plano exige motivo, e grava quem autorizou.
- Reajuste é contrato a contrato, pode ter data futura, e nada é sobrescrito.
Regras de cobrança
| Estado do recebimento | O que significa | Cobra automático |
|---|---|---|
| Configurado | Credencial gravada, nunca testada | Não |
| Verificado | A conexão respondeu | Sim |
| Com falha | O teste foi feito e falhou | Não |
Sem Verificado, o débito automático não é ativado. A cobrança recorrente sai sozinha meses depois, sem ninguém olhando.
| Situação da parcela | O que significa |
|---|---|
| Pendente | Emitida, aguardando |
| Processando | Enviada ao gateway |
| Paga | Baixada |
| Falhou | Recusada — entra na régua de retentativa |
| Cancelada | O contrato saiu de vigor |
| Estornada | Devolvida |
- A régua de retentativa usa os intervalos configurados. Esgotada a régua, a cobrança para de tentar sozinha.
- O webhook é idempotente: o mesmo evento reprocessado não baixa a parcela duas vezes.
- Nenhum dado de cartão fica no banco — só o token do gateway.
O que cada gateway faz
Capacidades são declaradas por gateway, e a tela encolhe sozinha conforme elas.
| Gateway | Meios | Recorrência | Assina webhook | Estorna |
|---|---|---|---|---|
| Gateway de teste | Pix, boleto, cartão, Pix Automático | Sim | Sim | Sim |
| PSP somente Pix | Pix | Não | Não | Não |
Um gateway sem recorrência não oferece débito automático — e diz isso ao ser pedido, em vez de falhar em silêncio no mês seguinte.
Regras de mensagem
| Tipo | Canal | Sai quando |
|---|---|---|
| Boas-vindas | Matrícula | |
| Cobrança | Cobrança emitida | |
| Falha no débito automático | Gateway recusa | |
| Vencimento próximo | Régua disparada | |
| Atestado a vencer | Régua disparada | |
| Reativação | Régua disparada |
- Só estas variáveis são preenchidas:
aluno,academia,matricula,plano,valor,vencimento,linkPagamento,validadeAtestado. Qualquer outra é recusada ao salvar. - Rodar a régua de novo não repete mensagem. Quem já foi avisado daquele fato não é avisado outra vez.
- Sem destino é estado próprio, diferente de Falhou: um é cadastro incompleto, o outro é o canal recusando.
Regras de prescrição
- Consentimento por finalidade. Treino, dieta e biometria são três aceites separados. Um não vale pelo outro.
- Prescrever de novo não apaga a anterior: entra uma versão nova, a antiga fica legível.
- Uma ficha vigente por aluno.
- Modelo é copiado, não vinculado. Editar o modelo depois não muda quem já o recebeu.
- Substituída ≠ Encerrada: uma teve sucessora, a outra não.
Dado de saúde e biometria
| Dado | Consentimento | Onde fica | Exclusão |
|---|---|---|---|
| Restrição clínica | Implícito no cadastro | Ficha do aluno | Com o aluno |
| Treino | Finalidade TREINO | Prescrição versionada | Revoga o aceite |
| Dieta | Finalidade DIETA | Prescrição versionada | Revoga o aceite |
| Biometria | Finalidade BIOMETRIA | Cifrada, cofre AES-GCM | Apagada de verdade |
A biometria é o único dado que o titular não pode trocar. Por isso ela é a única exceção ao apagamento lógico do módulo: apagar a digital apaga a linha, e o consentimento cai junto.
O template biométrico nunca sai do servidor para uma tela. Ele é decifrado só para ir ao equipamento.
Regras de catraca
- A catraca decide offline, contra a lista sincronizada. O servidor sincroniza; não decide na hora da passagem.
- A lista vence. Passado o prazo, o dispositivo entra em modo degradado.
- Cada pessoa leva a própria validade — atestado ou fim de contrato, o que vier primeiro. É o que permite barrar sem sincronização nova.
- A passagem offline é registrada, não re-julgada: ela já aconteceu.
- Decidido offline ≠ liberado manualmente. Um é o servidor não ter sido consultado; o outro é a recepção passando por cima.
- Um cartão, um aluno.
- Reenviar o mesmo lote de passagens não duplica.
O que cada fabricante faz
| Fabricante | Formato | Cartão/QR | Biometria | Agente exigido |
|---|---|---|---|---|
| Simulador | CSV | Sim | Não | Qualquer |
| Henry | JSON | Sim | Sim | 2.0 ou acima |
O template biométrico não vai para equipamento que não lê biometria.
Regras de captação
- Interessado não é aluno. Lista separada; não conta em nenhum número da operação.
- A academia vem da chave de API, nunca do corpo da requisição.
- Reenviar o formulário atualiza o interessado, não duplica.
- Perder exige o motivo.
- Converter é matricular: não há como declarar convertido sem aluno.
- O interessado não é apagado ao virar aluno.
Campos próprios
- Até 20 por tela, em Alunos e Interessados.
- O nome interno nunca muda — é a chave das respostas já dadas.
- O tipo não muda depois de criado.
- Desativar não apaga as respostas.
- No formulário público: obrigatório não é exigido, campo desconhecido é descartado, texto longo é cortado.
Regras de agregador
- Cada rede tem sua própria chave de ativação. Uma desligada não impede a outra.
- Rede desligada é indistinguível de rede inexistente.
- Quem chega pela rede não passa pelas regras de contrato — ele não tem contrato. Mas se também for aluno da casa, as regras da casa valem.
- A passagem por rede conta na frequência, com origem própria.
O que o sistema recusa, e por quê
| Recusa | Por quê |
|---|---|
| Plano com nome repetido | Nome é único na academia |
| Horário do plano pela metade | Meio horário não descreve nada |
| Segundo contrato para o mesmo aluno | Um contrato em vigor por vez |
| Valor negociado sem motivo | Seis meses depois alguém vai perguntar |
| Excluir plano com contrato em vigor | Deixaria alunos sem plano |
| Débito automático sem gateway verificado | Cobrança que ninguém vê acontecer |
| Liberar atestado vencido no balcão | Segurança física, não comercial |
| Liberar sem justificativa | O registro não explicaria nada depois |
| Variável desconhecida na mensagem | Sairia apagada, truncando a frase |
| Régua com mais de 30 dias de antecedência | Vira ruído |
| Prescrever sem consentimento | LGPD art. 5º II — e art. 11 na biometria |
| Exercício de outra academia na ficha | Isolamento entre academias |
| Excluir exercício em uso | Esvaziaria fichas já prescritas |
| Capturar biometria de qualidade baixa | Só se descobre na porta, dias depois |
| Biometria como credencial comum | Iria para uma coluna em claro |
| Campo próprio repetido na mesma tela | Dois viram a mesma chave |
| Trocar o tipo de um campo | As respostas deixariam de valer |
| Cartão já usado por outro aluno | Abriria a porta para a pessoa errada |
| Fabricante de catraca sem driver | Falharia calado, na inauguração |
| Marcar interessado como convertido | Converter é matricular |
| Perder interessado sem motivo | O funil contaria sem explicar |
| Mais de 30 envios por minuto na chave | Encher a base de lixo custaria zero |
| Aluno lendo dado de outro aluno | O id vem do token, não da URL |