Bem-vindo à documentação da API OctaLife. Crie tribos, gerencie tiers, assinaturas, membros, posts, treinos prescritos e webhooks via API.

Documentação da API OctaLife

Integre a plataforma de comunidades fitness pagas diretamente em suas aplicações. Crie tribos, configure tiers de assinatura, gerencie membros, publique conteúdo e monitore receita programaticamente.

API RESTful

A API OctaLife é RESTful, usa JSON para requests/responses e autenticação via API Key no header Authorization. Stripe Connect cuida de pagamentos.

O que a API oferece

┌─────────────────────────────────────────────────────────────┐
│                     Sua Aplicação                           │
└─────────────────────────┬───────────────────────────────────┘
                          │
                          ▼
┌─────────────────────────────────────────────────────────────┐
│                    API OctaLife                             │
│  ┌───────────────────────────────────────────────────────┐  │
│  │  • Tribos (Communities)    • Tiers de assinatura     │  │
│  │  • Assinaturas              • Membros                 │  │
│  │  • Posts (Feed)             • Treinos prescritos      │  │
│  │  • Desafios                 • Saques (Payouts)        │  │
│  │  • Métricas do Creator      • Webhooks                │  │
│  └───────────────────────────────────────────────────────┘  │
└─────────────────────────────────────────────────────────────┘

Por que usar a API OctaLife?

Benefício	Descrição
Automação de tribos	Crie comunidades, tiers e posts via API sem acessar o painel
Sync de membros	Importe/exporte membros entre seus sistemas existentes
Monetização nativa	Stripe Connect já integrado — assinaturas, saques e métricas vêm prontos
Eventos em tempo real	Webhooks para `subscription.created`, `payout.paid`, `pr.detected` e mais
Segurança	Autenticação via API Key com escopo por creator e RLS no banco

Primeiros Passos

Obtenha suas credenciais

Acesse Configurações → API Keys no painel do OctaLife e gere suas chaves de API. Cada chave está vinculada à sua conta de creator e tem acesso aos recursos das suas tribos.

Configure a autenticação

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

Authorization: Bearer ol_live_sua_chave_aqui

Faça sua primeira requisição

Teste a conexão listando suas tribos:

curl -X GET https://app.octalife.ai/api/v1/communities \
  -H "Authorization: Bearer ol_live_sua_chave_aqui" \
  -H "Content-Type: application/json"

Base URL

Todas as requisições devem ser feitas para:

https://app.octalife.ai/api/v1

Fluxo Típico de Integração

1. Criar tribo        →  POST /api/v1/communities
                              ↓
2. Adicionar tiers    →  POST /api/v1/tiers
                              ↓
3. Publicar conteúdo  →  POST /api/v1/posts
                              ↓
4. Receber assinaturas → Webhook subscription.created
                              ↓
5. Monitorar saques   →  GET  /api/v1/payouts

Recursos Disponíveis

Autenticação

Como autenticar suas requisições e gerenciar API Keys

Tribos (Communities)

Criar, listar e gerenciar comunidades pagas

Tiers

Configurar níveis de assinatura, preços e benefícios

Assinaturas

Listar e gerenciar assinaturas ativas, trials e cancelamentos

Membros

Listar membros, ver acesso por tier e histórico

Posts

Publicar e gerenciar posts do feed da tribo

Treinos Prescritos

Criar programas e treinos com séries, carga e descanso

Desafios

Criar desafios com leaderboard e regras automatizadas

Saques (Payouts)

Consultar histórico de saques e disponível na Stripe

Webhooks

Receber notificações de eventos em tempo real

Conceitos Importantes

Creators e Tribos

A unidade central do OctaLife é o creator — uma conta que gerencia uma ou mais tribos (comunidades pagas). Sua API Key está vinculada à sua conta de creator e tem acesso a todas as suas tribos.

Internamente, cada tribo é "backed" por um team isolado (RLS) — mas isso é transparente pra integração via API.

Tiers e Assinaturas

Tier: nível de assinatura com preço, benefícios e duração (mensal, anual, trial)
Subscription: assinatura ativa de um membro em um tier específico
Assinaturas são processadas via Stripe Connect — você recebe 90%

Ciclo de Vida da Assinatura

trialing → active → past_due → canceled
              │         │
              └─────────┘
              (retry automático)

trialing: período de avaliação (gratuito)
active: assinatura ativa, cobrança recorrente em dia
past_due: pagamento falhou, retry em curso
canceled: cancelada (pelo membro ou creator)

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@octalife.ai
Painel: app.octalife.ai
Documentação: Você está aqui!

Introdução