Onboarding de Clientes - Visão Geral¶

Sistema completo para criar fluxos personalizados de onboarding para seus clientes.

O que é o módulo de Onboarding?¶

O módulo de Onboarding permite que você crie jornadas guiadas e personalizadas para integrar novos clientes à sua plataforma ou serviço. Com ele, você pode:

• ✅ Criar fluxos de onboarding customizados
• ✅ Traduzir conteúdo para múltiplos idiomas
• ✅ Acompanhar o progresso de cada cliente
• ✅ Medir taxas de conclusão e abandono
• ✅ Integrar via API REST pública

Como Funciona¶

Componentes principais¶

Fluxo de Onboarding
- Estrutura completa do processo de integração
- Contém etapas sequenciais ou modulares
- Suporta múltiplos idiomas
- Configurações personalizáveis

Etapas
- Passos individuais do fluxo
- Conteúdo formatado (Markdown/HTML)
- Traduções para diferentes idiomas
- Ordem e hierarquia configuráveis

Progresso do Usuário
- Rastreia avanço de cada cliente
- Armazena dados coletados em cada etapa
- Status: Não iniciado, Em progresso, Concluído, Abandonado

Tipos de Fluxo¶

LINEAR¶

Sequência fixa de etapas que todos os usuários seguem na mesma ordem.

Exemplo de uso:
- Onboarding de funcionários
- Tutorial de produto
- Checklist de configuração

MODULE_BASED¶

Baseado em módulos selecionados pelo cliente.

Exemplo de uso:
- Ativação de funcionalidades
- Personalização por plano
- Configuração modular

CONDITIONAL¶

Ramificações baseadas em respostas ou condições.

Exemplo de uso:
- Qualificação de leads
- Configuração contextual
- Fluxos adaptativos

Como Implementar¶

Lado do Administrador (Dashboard)¶

1. Criar Flow: Define nome, tipo, idioma padrão
2. Adicionar Steps: Cria etapas com conteúdo em Markdown
3. Traduzir: Adiciona versões em outros idiomas
4. Configurar: Define passos obrigatórios, opcionais, ordem
5. Publicar: Ativa o flow e obtém API key

Lado do Cliente (API Pública)¶

1. Obter Estrutura: GET /{public_key}/structure
2. Iniciar Flow: POST /{public_key}/start
3. Completar Steps: POST /{public_key}/progress/{user_id}/complete-step
4. Consultar Progresso: GET /{public_key}/progress/{user_id}

Internacionalização¶

O sistema suporta múltiplos idiomas através de traduções em nível de step:

• Um FlowStep pode ter várias traduções (mesmo step_key, language diferente)
• O progresso do usuário é independente de idioma (armazena apenas step_key)
• Ao consultar, o sistema retorna steps no idioma preferido do usuário
• Fallback automático para idioma padrão se tradução não existir

Idiomas suportados:
- pt-BR - Português (Brasil)
- en-US - English (US)
- es-ES - Español
- fr-FR - Français

Métricas e Analytics¶

O sistema rastreia automaticamente:

• ✓ Total de inícios (total_starts)
• ✓ Total de conclusões (total_completions)
• ✓ Taxa de conclusão (completion_rate)
• ✓ Tempo médio de conclusão
• ✓ Abandonos por etapa
• ✓ Progresso individual de cada usuário

Segurança e Acesso¶

API Administrativa (Autenticada)¶

• Requer autenticação JWT
• Acesso via dashboard da Organization
• CRUD completo de flows e steps

API Pública (public_key)¶

• Acesso via public_key do flow (chave pública)
• Apenas leitura de estrutura e gestão de progresso
• Rate limiting configurável
• Webhooks para eventos importantes

Proteção por Origem (allowed_origins)¶

Para proteger seu endpoint de acessos não autorizados:

1. Acesse o detalhe do fluxo no dashboard
2. Configure o campo Origens Permitidas:
   json ["https://app.seucliente.com", "https://www.seucliente.com"]
3. Salve o fluxo

Como funciona:
- Se allowed_origins estiver vazio → aceita qualquer origem
- Se configurado → valida o header Origin da requisição
- Requisições server-to-server (sem Origin) → sempre permitidas

Próximos Passos¶

Para começar a usar o módulo de Onboarding, consulte:

• Configuração de Fluxos → - Como criar e configurar flows
• Usando a API Pública → - Integração com sua aplicação
• Métricas e Indicadores → - Acompanhamento e análise

Casos de Uso Comuns¶

1. Onboarding de SaaS¶

Cliente se cadastra → Configura conta → Importa dados → Primeiro uso → Ativação

2. Treinamento de Produto¶

Bem-vindo → Funcionalidade 1 → Funcionalidade 2 → Primeira ação → Certificação

3. Qualificação de Leads¶

Perfil → Necessidades → Orçamento → Agenda demo → Proposta

4. Configuração de Integrações¶

Conectar API → Mapear campos → Testar conexão → Primeira sincronização → Conclusão

Dúvidas? Consulte nossa documentação completa ou entre em contato com o suporte.