Referência da API
Documentação completa de todos os endpoints da API OctaLife para creators e integrações.
Referência da API
Documentação completa de todos os endpoints disponíveis na API pública v1 do OctaLife.
Base URL
https://app.octalife.ai/api/v1Endpoints Disponíveis
Tribos (Communities)
Gerenciar comunidades pagas, capa, regras e visibilidade.
Tiers
Configurar tiers de assinatura, preços, trial e benefícios.
Assinaturas
Listar e gerenciar assinaturas, trials e cancelamentos.
Membros
Listar membros das suas tribos com tier e status.
Posts
Publicar posts no feed com paywall por tier.
Treinos prescritos
Programas com séries, carga, descanso e tracking.
Desafios
Desafios temporários com leaderboard automático.
Saques (Payouts)
Histórico de saques e disponível na Stripe.
Métricas do Creator
MRR, churn, retenção e funil por tier.
Webhooks
Eventos em tempo real (subscription, payout, PR detectado).
Padrão de Resposta
Todas as respostas seguem a estrutura:
{
"success": true,
"data": { ... },
"pagination": {
"page": 1,
"limit": 20,
"total": 124,
"pages": 7
}
}Em caso de erro:
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "O campo `name` é obrigatório.",
"details": { "field": "name" }
}
}Códigos HTTP
| Código | Significado |
|---|---|
200 | OK — requisição bem-sucedida |
201 | Created — recurso criado |
400 | Bad Request — corpo inválido |
401 | Unauthorized — API Key inválida |
403 | Forbidden — recurso não pertence ao creator |
404 | Not Found — recurso não existe |
429 | Too Many Requests — limite de rate limit excedido |
500 | Internal Server Error — erro interno |
Sempre verifique o campo success antes de processar data.