Skip to main content

​
Tasks - Documentação BAAS Owem

​
🎯 OBJETIVO: Transformar Docs de PIX → Docs de BAAS

Contexto: Esta documentação será para parceiros selecionados que usam o sistema BAAS (Banking as a Service) para criar contas bancárias para seus clientes. Público-alvo: Parceiros B2B autorizados (acesso restrito)

​
Status Geral

ÁreaStatusAção
Index/Introdução🔄 AdaptarReescrever para BAAS
Quickstart🔄 AdaptarFluxo de onboarding BAAS
API Reference🔄 AdaptarManter apenas endpoints BAAS
Conceitos✅ ManterAutenticação, rate limiting
Produtos PIX⚠️ RevisarSimplificar ou mover para anexo
Guides🔄 AdaptarCriar fluxo BAAS
AI Tools✅ ManterMCP, Cursor, etc.

​
📋 PLANO DE TRANSFORMAÇÃO

​
FASE 1: Atualizar Estrutura (docs.json)

  • Renomear para “Owem BAAS - Documentação”
  • Ajustar navigation para foco em BAAS
  • Remover tabs/grupos desnecessários

​
FASE 2: Criar/Atualizar Páginas Principais

PáginaStatusAção
index.mdx🔄 EditIntrodução ao BAAS
quickstart.mdx🔄 EditFluxo de onboarding BAAS
changelog.mdx✅ KeepManter

​
FASE 3: Endpoints BAAS (Nova Seção)

EndpointMétodoDescriçãoStatus
/v4/i/baas/onboarding/newPOSTCriar proposta de abertura⏳ Criar
/v4/i/baas/onboarding/:userIdGETConsultar status onboarding⏳ Criar
/v4/i/baas/onboarding/:userId/docsPOSTUpload manual de documentos⏳ Criar
/v4/i/baas/accounts/:accountIdGETConsultar conta criada⏳ Criar
/v4/i/baas/accounts/:accountId/balanceGETConsultar saldo⏳ Criar

​
FASE 4: O Que MANTER da Documentação Atual

SeçãoArquivosMotivo
Conceitosautenticacao-seguranca.mdxAPI Key + allowlist IP
Conceitoscodigos-erro.mdxCódigos de erro
Conceitosrate-limiting.mdxLimites de requisição
Produtoswebhooks.mdxWebhooks BAAS
AI ToolsTodosManter integração IA

​
FASE 5: O Que MANTER (Documentação Completa)

SeçãoArquivosStatus
Produtospix-in.mdx, pix-out.mdx✅ MANTER
Produtosledger.mdx, webhooks.mdx✅ MANTER
Guidesreceber-pagamentos.mdx✅ MANTER
Guidesenviar-pagamentos.mdx✅ MANTER
Guidesconciliacao.mdx, meds.mdx✅ MANTER
API ReferenceTodos endpoints PIX IN/OUT✅ MANTER
API ReferenceLedger, Webhooks, MEDs✅ MANTER

​
FASE 6: O Que ADICIONAR

SeçãoArquivo NovoConteúdo
Conceitosfluxo-onboarding.mdxDiagrama do fluxo BAAS
Guidescriar-conta-cliente.mdxPasso a passo onboarding
Guideswebhooks-baas.mdxEventos BAAS específicos

​
🔧 DECISÕES DE ESCOPO

​
✅ Opção B: Documentação BAAS Completa (ESCOLHIDA)

  • Mantém TODOS os endpoints existentes (PIX IN, PIX OUT, Ledger, Webhooks, MEDs)
  • Adiciona endpoints BAAS de onboarding
  • Usuário tem tudo em um lugar só
  • Vantagem: Documentação completa, sem precisar consultar outra doc
Decisão: Opção B - BAAS + APIs Completas

​
📁 ESTRUTURA FINAL (Documentação Completa)

📁 BAAS Documentação
├── 🏠 Introdução (O que é BAAS Owem)
├── 🚀 Quickstart (Criar primeira conta)
├── 📋 Changelog

├── 📚 Conceitos
│   ├── Autenticação & Segurança
│   ├── Ambientes & Variáveis
│   ├── Códigos de Erro
│   ├── Glossário
│   └── Rate Limiting

├── 🎯 Produtos
│   ├── PIX IN - Recebimentos
│   ├── PIX OUT - Pagamentos
│   ├── Ledger
│   └── Webhooks

├── 📖 Guias
│   ├── Usando o Painel
│   ├── Receber Pagamentos
│   ├── Enviar Pagamentos
│   ├── Webhooks
│   ├── Conciliação
│   └── MEDs

├── 🤖 AI Tools
│   ├── Menu Contextual
│   ├── MCP
│   ├── Cursor
│   ├── Claude Code
│   └── Windsurf

└── 🔧 API Reference
    ├── Visão Geral
    ├── 🆕 BAAS Onboarding
    │   ├── POST /new (criar proposta)
    │   ├── GET /:userId (status)
    │   └── POST /:userId/documents (upload)
    ├── 🆕 BAAS Accounts
    │   └── GET /:accountId
    ├── Autenticação (ping)
    ├── Conta Bancária (saldo)
    ├── Ledger (4 endpoints)
    ├── PIX IN (4 endpoints)
    ├── PIX OUT (2 endpoints)
    ├── Webhooks (7 endpoints)
    └── MEDs (2 endpoints)

​
⏳ PRÓXIMOS PASSOS

  1. Atualizar docs.json com nova estrutura
  2. Reescrever index.mdx para BAAS
  3. Reescrever quickstart.mdx para fluxo onboarding
  4. Criar endpoints BAAS em api-reference/
  5. Remover arquivos desnecessários
  6. Atualizar conceitos para BAAS
  7. Testar navegação no localhost

​
Commits Recentes

  • plan: Definir escopo documentação BAAS