Skip to main content

Active Context - Documentação BAAS Owem

Sessão Atual

Data: 2025-01-08 Status: 📋 PLAN MODE - Definindo escopo da transformação

🎯 OBJETIVO

Transformar a documentação atual (focada em PIX) para uma documentação específica de BAAS (Banking as a Service) para parceiros selecionados.

📊 ANÁLISE: O Que Temos vs O Que Precisamos

Documentação Atual (Herdada de PIX)

✅ Conceitos (úteis para BAAS)
   - Autenticação → MANTER (adaptar para API Key BAAS)
   - Códigos de Erro → MANTER
   - Rate Limiting → MANTER

❌ Produtos PIX (não se aplica a parceiros)
   - PIX IN → REMOVER
   - PIX OUT → REMOVER
   - Ledger → REMOVER ou simplificar

❌ Guides de Pagamento (não se aplica)
   - Receber Pagamentos → REMOVER
   - Enviar Pagamentos → REMOVER

✅ AI Tools → MANTER
   - MCP, Cursor, Claude Code, Windsurf

Documentação BAAS (O Que Criar)

📋 Introdução ao BAAS Owem
🚀 Quickstart: Primeira Conta
📖 Guia: Fluxo Completo de Onboarding

🔧 API Reference BAAS:
   POST /v4/i/baas/onboarding/new
   GET  /v4/i/baas/onboarding/:userId
   POST /v4/i/baas/onboarding/:userId/documents
   GET  /v4/i/baas/accounts/:accountId

📡 Webhooks BAAS:
   baas:onboarding.proposal.updated
   baas:onboarding.account.created

🏗️ DECISÃO ARQUITETURAL

Opção Escolhida: Documentação BAAS Pura

Racional:
  1. Parceiros BAAS não operam PIX diretamente
  2. Evita confusão com docs.owem.com.br (documentação pública)
  3. Foco em onboarding e gestão de contas
  4. Documentação mais limpa e objetiva

O Que Parceiros BAAS Fazem:

1. Criar proposta de conta → POST /onboarding/new
2. Redirecionar cliente para widget KYC → URL retornada
3. Receber webhook quando aprovado → account.created
4. Consultar dados da conta criada → GET /accounts/:id

O Que Parceiros BAAS NÃO Fazem:

❌ Gerar QR Codes PIX
❌ Enviar PIX OUT
❌ Consultar Ledger
❌ Gerenciar webhooks de transação

📁 ESTRUTURA PROPOSTA docs.json

{
  "tabs": [
    {
      "tab": "Documentação",
      "groups": [
        { "group": "Começando", "pages": ["index", "quickstart", "changelog"] },
        {
          "group": "Conceitos",
          "pages": [
            "conceitos/autenticacao",
            "conceitos/fluxo-onboarding",
            "conceitos/codigos-erro"
          ]
        },
        {
          "group": "Guias",
          "pages": ["guides/criar-conta", "guides/webhooks-baas"]
        },
        { "group": "AI Tools", "pages": ["ai-tools/..."] }
      ]
    },
    {
      "tab": "API Reference",
      "groups": [
        { "group": "Visão Geral", "pages": ["api-reference/introduction"] },
        {
          "group": "Onboarding",
          "pages": [
            "api-reference/onboarding/new",
            "api-reference/onboarding/status",
            "api-reference/onboarding/documents"
          ]
        },
        {
          "group": "Accounts",
          "pages": [
            "api-reference/accounts/get",
            "api-reference/accounts/balance"
          ]
        },
        { "group": "Webhooks", "pages": ["api-reference/webhooks/events"] }
      ]
    }
  ]
}

⏳ PRÓXIMOS PASSOS

  1. Confirmar escopo com usuário
  2. Atualizar docs.json com nova estrutura
  3. Reescrever páginas principais
  4. Criar documentação dos endpoints BAAS
  5. Remover arquivos desnecessários
  6. Testar no localhost

📝 NOTAS DA SESSÃO

  • Documentação BAAS é restrita a parceiros selecionados
  • API usa X-API-Key com scope baas:onboarding
  • Widget CAF para KYC (não SDK direto)
  • Conta bancária criada automaticamente após aprovação