Developers API & Widget
API Reference
PT

Primeiros passos

Fluxo de Integração

Caminho correto de uma integração de iframe. O callback é enviado antes de notificar a frontend.

sequenceDiagram
participant U as Usuário
participant W as Seu site
participant WG as Wealth Reader Widget
participant API as API de Wealth Reader
participant B as Instituição financeira
U->>W: Abra o app
W->>WG: Insira o iframe com operation_id
U->>WG: Escolha a entidade e dê consentimento
WG->>API: Solicite os dados com operation_id
API->>B: Peça os dados da conta
B-->>API: Retorna dados brutos
API-->>WG: Retorna dados normalizados
WG->>W: Envie um POST para o callback (operation_id + token + payload)
W-->>WG: Resposta HTTP 200 e status ok
WG-->>W: Envie postMessage flow completed
W-->>U: Exibe a tela de sucesso

Quem faz o quê

Ator Responsabilidade
Sua interface Gere um operation_id único, carregue o widget e ouça postMessage.
O widget Ele mostra bancos, login, 2FA e erros para o usuário.
A API de Wealth Reader Converse com a entidade e normalize a resposta.
Seu backend Expõe a URL do callback, responde {"status":"ok"} e salva operation_id, token e payload.

Se algo der errado

  • Senha incorreta, 2FA ou erro de entidade: o widget resolve isso com o usuário. Sua frente pode receber um erro JSON para postMessage; a callback não é chamada até que a leitura termine bem.
  • Seu callback não responde 200 + {"status":"ok"}: o usuário não vê sucesso e a frente não recebe flow completed.
  • Um token não é mais válido (mudança de senha, nova 2FA): reabra o widget passando essa token para o usuário autenticar novamente.

O detalhe de cada mensagem e o corpo da callback estão nas páginas do iframe.

Próximo passo

Se você integra por iframe, continue por Frontend e então Backend. Se você não consegue incorporar um iframe, vá para OAuth.

Última atualização