Developers API & Widget
API Reference
FI

Aloitus

Integraation kulku

Onnistunut polku iframe-integraatiossa. Callback lähetetään ennen kuin frontend saa ilmoituksen.

sequenceDiagram
participant User
participant Web
participant Widget as Wealth Reader Widget
participant API as Wealth Reader API
participant Bank as Rahoituslaitos
User->>Web: Avaa sovelluksen
Web->>Widget: Lataa iframe operation_id-tunnisteella
User->>Widget: Valitsee laitoksen ja antaa suostumuksen
Widget->>API: Pyytää tiedot operation_id-tunnisteella
API->>Bank: Kysely
Bank-->>API: Vastaa
API-->>Widget: Palauttaa normalisoidut tiedot
Widget->>Web: POST callbackiin (operation_id + token + payload)
Web-->>Widget: HTTP 200 ja status ok
Widget-->>Web: postMessage flow completed
Web-->>User: Näyttää onnistuneen valmistumisen

Kuka tekee mitä

Toimija Vastuu
Frontendisi Luo yksilöllisen operation_id-tunnisteen, lataa widgetin ja kuuntelee postMessage-viestejä.
Widget Näyttää käyttäjälle pankit, kirjautumisen, 2FA:n ja virheet.
Wealth Reader API Keskustelee laitoksen kanssa ja normalisoi vastauksen.
Backendisi Julkaisee callback-osoitteen, vastaa {"status":"ok"} ja tallentaa operation_id-tunnisteen, token-tunnuksen ja payloadin.

Jos jokin epäonnistuu

  • Väärä salasana, 2FA tai laitoksen virhe: widget hoitaa tilanteen käyttäjän kanssa. Frontendisi voi saada virhe-JSONin postMessage-viestinä; callbackia ei kutsuta ennen kuin luku onnistuu.
  • Callbackisi ei palauta 200 + {"status":"ok"}: käyttäjä ei näe onnistumista eikä frontend saa flow completed -viestiä.
  • token lakkaa toimimasta (salasanan vaihto, uusi 2FA): avaa widget uudelleen ja välitä kyseinen token, jotta käyttäjä voi tunnistautua uudelleen.

Viestien yksityiskohdat ja callbackin runko ovat iframe-sivuilla.

Seuraava vaihe

Jos integroit iframe-upotuksella, jatka frontendiin ja sitten backendiin. Jos iframea ei voi upottaa, siirry OAuthiin.

Päivitetty viimeksi