Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.cativa.digital/llms.txt

Use this file to discover all available pages before exploring further.

Toda integração com a Cativa começa pelo usuário. Esta página descreve o modelo User no nível conceitual e o endpoint canônico para validar credenciais.

​
O modelo User

Cada usuário na Cativa pertence a um único tenant e é identificado por um id (GUID). Os campos visíveis em respostas autenticadas incluem identidade básica (email, firstName, lastName, displayName, userName), URL pública da foto (pictureUrl), o role na comunidade, status da conta e o customer (tenant) ao qual o usuário pertence.
O contrato detalhado de cada response (incluindo nomes e tipos exatos de cada campo) será publicado em breve por endpoint, junto com o catálogo público da API.

​
Validar credencial e descobrir o usuário associado

O único endpoint canônico para parceiros validarem uma credencial e descobrirem o usuário associado é GET /social/v1/auth/me: 
curl https://apis.cativalab.digital/social/v1/auth/me \
  -H "Authorization: Bearer cativa_live_..." \
  -H "Cativa-Customer: comunidade-do-pedro"
Use o retorno para:
  • Confirmar que sua chave está válida e aponta pro tenant certo (campo customer).
  • Capturar o id do usuário associado à chave (útil pra logs e auditoria do seu lado).
  • Renovar a sessão usando os campos accessToken / refreshToken retornados.

​
Padrão de upsert por usuário externo

Endpoints de POST/PATCH/DELETE /users para parceiros externos (sincronização CRM, criação de usuário a partir de compra externa, soft-delete) serão publicados em breve. Por enquanto, alinhe com o time da Cativa via dev@cativa.digital para discutir o fluxo do seu caso.

​
Próximos passos

Badges como permissão

Como atribuir credenciais a um usuário para liberar acesso a grupos e cursos.

Comunidades e Espaços

Onde o usuário se encaixa na hierarquia de Comunidade > Espaço > Grupo.