Pular para o conteúdo principal

Introdução à API Ozzie

A API Ozzie é uma API REST de inteligência financeira que permite adicionar um assistente financeiro pessoal a qualquer produto. Com uma única integração, seu produto ganha rastreamento de despesas, planos financeiros personalizados, metas, tarefas semanais acionáveis e um coach de IA — tudo em português, inglês ou espanhol.

O que você pode construir

  • Apps fintech — Incorpore coaching financeiro com IA, rastreamento de gastos e planos personalizados ao seu produto existente
  • Bots de WhatsApp — Permita que usuários enviem despesas por mensagem de texto ou foto de comprovante, sem precisar baixar um app
  • Dashboards de analytics — Acesse dados estruturados de transações, insights de gastos e progresso de metas para construir visualizações ricas
  • Coaches financeiros embutidos — Forneça um chat de IA que entende o contexto financeiro completo de cada usuário

Conceitos principais

ConceitoDescrição
UsuárioUm perfil financeiro vinculado ao seu sistema via external_user_id
Intake financeiroSnapshot mensal de renda e despesas — base do plano
TransaçõesDespesas e receitas individuais, extraídas por IA de texto, imagem, PDF ou planilha
MetaObjetivo financeiro ativo (poupança ou quitação de dívida)
Money MovesTarefas semanais acionáveis (Agir, Aprender, Refletir)
PlanoRoteiro financeiro personalizado com cronograma, alocações e métricas
ChatCoach de IA que responde no idioma do usuário com contexto financeiro completo

Princípios de design da API

  • REST com envelopes JSON — todas as respostas usam { "object": "tipo", "data": {...} }
  • Paginação por cursor — listas usam cursor, limit, has_more e next_cursor
  • Formato de erro consistente{ "error": { "code": "CODIGO", "message": "..." } }
  • Multi-idioma — defina language no usuário e todas as respostas da IA usam esse idioma