Skip to main content
A Cativa é uma plataforma de comunidades white-label multi-tenant. Cada cliente (um “tenant”) tem sua própria comunidade com usuários, grupos, cursos, eventos, loja e pagamentos, tudo sob a marca dele. Esta API abre esse mundo para você: automatizar cadastros, liberar acesso, receber eventos em tempo quase real e conectar a Cativa ao resto do seu stack. Se você nunca integrou com a Cativa, comece por um dos dois quickstarts abaixo. Um leva 2 minutos, o outro 5.

Primeira chamada de API

Em 2 minutos: crie uma API Key e faça seu primeiro request autenticado. Ideal para scripts e integrações server-to-server.

Login com a Cativa

Em 5 minutos: deixe usuários da Cativa entrarem no seu app via OAuth 2.0 com PKCE.

​
O que dá pra construir

  • Sincronização bidirecional com seu CRM (HubSpot, RD Station, Pipedrive)
  • Liberação de acesso via compra externa (Hotmart, Kiwify, Eduzz, Shopify)
  • Connectors no-code (Zapier, Make.com, ActiveCampaign)
  • Agentes de IA via MCP (em breve)

​
Dois jeitos de autenticar

Antes de escolher um endpoint, escolha como você vai se autenticar. A regra é simples:

API Key (server-to-server)

Sua aplicação age em nome dela mesma. Envie Authorization: Bearer cativa_live_.... Use em jobs, sincronizações e backends sem usuário interativo.

OAuth 2.0 + PKCE (em nome do usuário)

O usuário final autentica com a conta dele da comunidade. Use quando você precisa da identidade do usuário no seu app.

​
Conceitos essenciais

Vale ler estes antes de mergulhar. Cada um explica um bloco da plataforma que você vai encontrar nos endpoints e nos webhooks.

Tenants e Customers

O que é um tenant, como o customerName aparece nas integrações e por que IDs são únicos por comunidade.

Identidade e usuários

O modelo de usuário: perfil, email normalizado, telefone E.164 e o ciclo de vida da conta.

Badges como permissão

Como badges controlam o acesso a grupos e cursos. Na Cativa, badge é permissão.

Comunidades e espaços

Grupos, espaços e como o conteúdo é organizado dentro de um tenant.

Posts e comentários

O feed da comunidade: posts, comentários e como eles se conectam aos grupos.

Eventos

Eventos ao vivo e agendados, integração com Zoom e o ciclo de participação.

Cursos e certificados

Cursos, aulas, progresso e emissão de certificados.

Loja e moedas

A economia interna: moedas, carteira e a loja da comunidade.

Links de pagamento e assinaturas

Paywalls, checkout e o que acontece quando um pagamento é confirmado.

Segmentação e funis

Como segmentar usuários e disparar automações a partir do comportamento deles.

​
Receba eventos com Webhooks

Em vez de ficar perguntando à API a cada minuto, deixe a Cativa te avisar quando algo acontece. Webhooks entregam eventos como user_created, user_received_badge e paywall_payment_completed no seu endpoint, assinados com HMAC.

Webhooks (visão geral)

Por que webhooks, garantias de entrega, assinatura HMAC e retries.

Cadastrar e verificar

O passo a passo: cadastrar listener, verificar assinatura e lidar com idempotência.

​
Guias práticos

Implementar Login com a Cativa

O guia profundo de SSO: SPA, backend e mobile, com validação de id_token via JWKS.

Liberar acesso via compra

Concretize o fluxo de compra externa que libera acesso na comunidade.

Sincronizar membros do CRM

Mantenha usuários em dia entre o seu CRM e a Cativa.

Login federado

Conecte a Cativa a um provedor de identidade que você já usa.

​
Precisa de ajuda?

Suporte

Envie um email com um exemplo do request e o traceId retornado no corpo de erro. Respondemos em até 1 dia útil.