Primeiros passos

Introdução

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

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

Antes de começar

Precisa de:

Um registo concluído e uma api_key.
Uma sessão de onboarding com a equipa técnica. Reserve a sua a partir de Suporte.
Decidir o tipo de integração (abaixo).
Um URL HTTPS que receba o callback, se integrar via iframe.

Escolha o tipo de integração

Critério	Iframe (widget)	OAuth
Quando	Aplicação web que pode incorporar um iframe	Aplicação nativa, ou não consegue incorporar um iframe
Frontend	Insere o widget na sua página	Redireciona o utilizador para `oauth.wealthreader.com`
Dados	Chegam num `POST` ao seu URL de callback	Obtém-nos ao completar o desafio em `/token/`
Comece por	Iframe: frontend	OAuth: backend

A maioria dos clientes web usa o iframe.

Como funciona (iframe)

A sua página carrega o widget com um operation_id que gera.
O utilizador escolhe a instituição, dá o consentimento e conclui a autenticação de dois fatores se for necessário. O widget trata desses passos.
O Wealth Reader obtém os dados e faz duas coisas, por esta ordem:
- No backend, envia o JSON completo para o URL de callback que configurou. O operation_id viaja nessa resposta para que o possa associar à operação do frontend.
- No frontend, o iframe notifica a sua página com postMessage (flow completed) apenas se o callback tiver tido sucesso. Use-o para fechar o seletor ou mostrar um ecrã de sucesso.

O operation_id é a ponte entre o frontend e o backend. Sem ele não consegue cruzar o que aconteceu no navegador com os dados que chegam ao seu servidor.

A mensagem flow completed não contém os dados bancários. Os dados vão para o callback. Se o callback não responder HTTP 200 com {"status":"ok"}, o frontend não recebe flow completed.

Última atualização 2026-08-14