Developers API & Widget
API Reference
CA

Primers passos

Flux d'integració

Camí correcte d'una integració iframe. La trucada de retorn s'envia abans d'avisar el frontend.

sequenceDiagram
participant Usuario
participant Web
participant Widget as Wealth Reader Widget
participant API as Wealth Reader API
participant Banco as Entidad Financiera
Usuario->>Web: Abre la aplicación
Web->>Widget: Carga el iframe con operation_id
Usuario->>Widget: Elige entidad y da consentimiento
Widget->>API: Solicita los datos con operation_id
API->>Banco: Consulta
Banco-->>API: Responde
API-->>Widget: Devuelve datos normalizados
Widget->>Web: POST al callback (operation_id + token + payload)
Web-->>Widget: HTTP 200 y status ok
Widget-->>Web: postMessage flow completed
Web-->>Usuario: Muestra finalización OK

Qui fa què

Actor Responsabilitat
La teva interfície Genera un operation_id un, carrega el widget i escolta postMessage.
El Widget Mostra bancs, inici de sessió, 2FA i errors a l'usuari.
L'API de Wealth Reader Parla amb l'entitat i normalitza la resposta.
El teu backend Exposa l'URL de callback, respostes {"status":"ok"} i desades operation_id, token i la càrrega útil.

Si alguna cosa va malament

  • Contrasenya incorrecta, 2FA o error d'entitat: el widget ho resol amb l'usuari. La teva part frontal pot rebre un error JSON per postMessage; la trucada de retorn no es crida fins que la lectura acaba amb èxit.
  • La teva callback no respon 200 + {"status":"ok"}: l'usuari no veu èxit i el front no rep flow completed.
  • Un token cessament de ser vàlid (canvi de contrasenya, nova 2FA): reobrir el widget passant aquest token perquè l'usuari pugui tornar a autenticar-se.

El detall de cada missatge i el cos de la devolució de la trucada es troben a les pàgines de l'iframe.

Següent pas

Si estàs integrant per iframe, passa per frontend ] i després backend. Si no pots incrustar un iframe, ves a OAuth.

Última actualització