Developers API & Widget
API Reference
PT

Primeiros passos

Introdução

Este guia explica como integrar Wealth Reader: o usuário escolhe seu banco, se autentica e seu sistema recebe os dados normalizados.

Exemplo do resultado final: https://widget.wealthreader.com/demo-all/

Antes de começar

Você precisa:

  • Ter concluído o cadastro e dispor de uma api_key.
  • Uma sessão de integração com a equipe técnica. Reserve o seu em Apoio.
  • Decida o tipo de integração (abaixo).
  • Uma URL HTTPS receber o callback, se você integrar por iframe.

Escolha o tipo de integração

Critérios Iframe (widget) OAuth
Quando Aplicação web que pode incorporar um iframe Aplicativo nativo, ou você não pode incorporar um iframe
Frontend Você incorpora o widget na sua página Você redireciona o usuário para oauth.wealthreader.com
Dados Eles chegam POST à sua URL callback Você os consegue completando o desafio em /token/
Comece com Iframe: frontend OAuth: backend

A maioria dos clientes web usa iframe.

Você programa com um assistente de IA? Instale o Wealth Reader habilidade em Claude Code, Codex, Cursor, Copilot ou Gemini CLI e gera a integração seguindo este guia.

Como funciona (iframe)

  1. Sua página carrega o widget com um operation_id que você gera.
  2. O usuário escolhe a entidade, dá consentimento e resolve a questão dos dois fatores, se necessário. O widget gerencia essas etapas.
  3. Wealth Reader recebe os dados e faz duas coisas, nesta ordem:
    • Para o backend, Wealth Reader envia o JSON completo à URL de callback configurada. O operation_id é enviado nessa resposta para relacionar os dados à operação do frontend.
    • No frontend, o iframe alerta sua página com postMessage (flow completed) apenas se o callback respondeu corretamente. Use para fechar o seletor ou exibir uma tela de sucesso.

A operation_id é a ponte entre a frente e a traseira. Sem ela, você não pode cruzar o que aconteceu no navegador com os dados que chegam ao seu servidor.

A mensagem flow completed não contém os dados do banco. Os dados viajam para a callback. Se o callback não responder HTTP 200 com {"status":"ok"}, a frente não recebe flow completed.

Última atualização