Bem-vindo à documentação da API OctaGym. Integre gestão de academias, alunos, planos, mensalidades e treinos em sua aplicação.

Documentação da API OctaGym

Integre a gestão completa da sua academia diretamente em suas aplicações. Gerencie alunos, planos, mensalidades, aulas, treinos, instrutores e controle de acesso de forma programática.

API RESTful

A API OctaGym é RESTful, utiliza JSON para requests/responses e autenticação via API Key no header Authorization.

O que a API oferece

┌─────────────────────────────────────────────────────────────┐
│                     Sua Aplicação                           │
└─────────────────────────┬───────────────────────────────────┘
                          │
                          ▼
┌─────────────────────────────────────────────────────────────┐
│                    API OctaGym                              │
│  ┌───────────────────────────────────────────────────────┐  │
│  │  • Alunos (Members)         • Planos                  │  │
│  │  • Mensalidades             • Aulas                   │  │
│  │  • Treinos                  • Exercícios              │  │
│  │  • Instrutores              • Métricas                │  │
│  │  • Controle de Acesso       • Webhooks                │  │
│  └───────────────────────────────────────────────────────┘  │
└─────────────────────────────────────────────────────────────┘

Por que usar a API OctaGym?

Benefício	Descrição
Integração Completa	Gerencie alunos, planos e mensalidades via API sem acessar a interface web
Automação	Crie mensalidades automaticamente ao cadastrar alunos em planos
Sincronização	Receba eventos em tempo real via webhooks (check-in, pagamento, cancelamento)
Escalabilidade	API otimizada para alto volume de requisições
Segurança	Autenticação via API Key com escopo por time e RLS no banco de dados

Primeiros Passos

Obtenha suas credenciais

Acesse Configurações → API Keys no painel do OctaGym e gere suas chaves de API.

Cada chave está vinculada ao seu time (academia) e tem acesso completo aos recursos do time.

Configure a autenticação

Todas as requisições devem incluir o header Authorization com sua API Key.

Authorization: Bearer og_live_sua_chave_aqui

Faça sua primeira requisição

Teste a conexão listando seus alunos:

curl -X GET https://dashboard.octagym.ai/api/v1/members \
  -H "Authorization: Bearer og_live_sua_chave_aqui" \
  -H "Content-Type: application/json"

Base URL

Todas as requisições devem ser feitas para:

https://dashboard.octagym.ai/api/v1

Fluxo Típico de Integração

1. Criar Aluno       →  POST /api/v1/members
                              ↓
2. Listar Planos     →  GET  /api/v1/plans
                              ↓
3. Criar Mensalidade →  POST /api/v1/memberships
                              ↓
4. Consultar Métricas → GET  /api/v1/gym-metrics

Recursos Disponíveis

Autenticação

Como autenticar suas requisições e gerenciar API Keys

Alunos

Cadastrar, listar e gerenciar alunos da academia

Planos

Consultar planos disponíveis e seus detalhes

Mensalidades

Criar e gerenciar mensalidades, cancelamentos e congelamentos

Aulas

Consultar grade de aulas e gerenciar reservas

Treinos

Criar e consultar programas de treino personalizados

Exercícios

Consultar o catálogo de exercícios disponíveis

Instrutores

Listar instrutores e consultar seus perfis

Métricas

Acompanhar MRR, churn, ocupação e indicadores da academia

Acesso

Monitorar ocupação e controle de acesso da academia

Webhooks

Receber notificações de eventos em tempo real

Todos os recursos pertencem a um time. No contexto do OctaGym, cada time representa uma academia (ou rede de academias). Sua API Key está vinculada a um time específico e só pode acessar recursos desse time.

Alunos (Members)

Alunos são compostos por duas entidades relacionadas:

client: Dados cadastrais básicos (nome, email, telefone)
member_profile: Dados específicos da academia (status, medidas, check-ins)

A API /members abstrai essa relação, permitindo gerenciar o aluno como uma entidade única.

Ciclo de Vida do Aluno

O status de um aluno segue o ciclo:

trial → active → frozen → cancelled
  │                │
  └────────────────┘
     (reativação)

trial: Período experimental
active: Aluno ativo com mensalidade vigente
frozen: Mensalidade congelada temporariamente
cancelled: Aluno cancelado / inativo

Limites de Uso

A API tem um limite de 100 requisições por minuto por API Key.

Exceder o limite resultará em resposta 429 Too Many Requests. Implemente retry com backoff exponencial.

Suporte

Precisa de ajuda com sua integração?

Email: suporte@octagym.ai
Dashboard: dashboard.octagym.ai
Documentação: Você está aqui!

Introdução