Developers API & Widget
API Reference
FI

IframeVaihe 1/2

Määritä frontend

Upota widget sivullesi, näytä pankkivalitsin ja kuuntele iframen viestejä.

Widget on iframe, joka ladataan osoitteesta https://widget.wealthreader.com/js/load.js. Tämä sivu kattaa vain frontendin. Callback ja pankkidata määritetään backendissä.

Sivun tarjoavan domainin on oltava valtuutettu asiakasalueella ennen widgetin avaamista. Muuten widget ilmoittaa, ettei domain ole valtuutettu.

Integraation tarkistuslista

0/3

Minimikoodi

Luo uusi operation_id jokaista operaatiota varten. Jätä entities_to_display tyhjäksi, jos haluat näyttää kaikki api_key-avaimesi laitokset. Pidä wait_full_response arvossa true, ellei tekninen tiimi toisin ohjeista.

<script>
    const wr_conf = {
        operation_id: crypto.randomUUID(),
        entities_to_display: [],
        wait_full_response: true
    };

    window.addEventListener("message", (event) => {
        if (event.origin !== "https://widget.wealthreader.com") {
            return;
        }

        if (event.data === "flow completed") {
            // The backend callback has already been sent successfully.
            // Close the selector or redirect to the success screen.
            return;
        }

        if (typeof event.data !== "string") {
            return;
        }

        try {
            const message = JSON.parse(event.data);
            if (message.error) {
                console.log(message.error.code, message.error.message);
                // OTP, wrong login, callback down, etc.
            }
        } catch (err) {
            // Ignore other iframe messages.
        }
    });
</script>

<iframe
    id="wr-iframe"
    title="Wealth Reader widget"
    width="100%"
    frameBorder="0"
    referrerpolicy="origin"
></iframe>
<script src="https://widget.wealthreader.com/js/load.js"></script>

load.js etsii iframen tunnisteella id="wr-iframe" ja asettaa sen korkeuden näkymän mukaan. Anna sille pystysuuntaista tilaa; jos sijoitat sen sivun keskelle, se voi leikkautua.

postMessage-viestit

Iframe kommunikoi sivusi kanssa näin:

event.data Milloin Mitä tehdä
"flow completed" Luku päättyi onnistuneesti ja callbackisi palautti 200 + {"status":"ok"} Sulje widget tai siirry onnistumisnäyttöön. Pankkidata ei kulje tässä viestissä.
JSON, jossa on error Kulku on yhä käynnissä (2FA, sopimus jne.) tai se epäonnistui Lue error.code ja error.message. Callbackia ei ole lähetetty.

Tarkista aina event.origin === "https://widget.wealthreader.com".

wr_conf-parametrit

Parametri Pakollinen Oletus Mitä se tekee
operation_id Kyllä Tunniste, jonka luot itse. Se palaa callbackissa, jotta voit yhdistää frontendin ja backendin.
entities_to_display Ei kaikki Laitoskoodien taulukko. Tyhjä tai puuttuva = kaikki. Lista: https://api.wealthreader.com/entities/
wait_full_response Ei true true: tuotteet ja tapahtumat. false: vain tuotelista.
date_from Ei eilen Tapahtumien alku, YYYY-MM-DD. Pätee vain, kun wait_full_response on true.
product_types Ei api_key-avaimesi arvot Tuotesuodatin. Taulukko tai pilkuilla erotettu lista.
default_login Ei Laitoskoodi. Avaa suoraan kyseisen laitoksen lomakkeen.
default_login_entity_country Ei ES ISO-maakoodi (ES, FR, …). Käytetään vain, kun default_login on asetettu.
token Ei Uudelleentunnistautuminen: esivalitsee pankin tokenista, joka ei enää ole voimassa.
psd2 Ei true Näytä PSD2-laitokset. Vain jos et suodata entities_to_display-parametrilla.
nonpsd2 Ei true Näytä non-PSD2-kanavan laitokset (rikkaampi data). Sama rajaus kuin psd2.
language Ei selaimen kieli "es" tai "en".
tokenize Ei asiakasalueen asetus true, jos haluat callbackissa uudelleenkäytettävän token-tunnuksen.
business_account Ei true Sisällytä yritysasiakkaiden laitokset.
personal_account Ei true Sisällytä henkilöasiakkaiden laitokset.

wait_full_response

Jätä se arvoon true. Poiskytkentä lyhentää odotusta (sekunteja), mutta tapahtumia ei tule. Älä poista sitä käytöstä ilman selvää UX-syytä; hae tapahtumat myöhemmin API:lla ja callbackin token-tunnuksella.

date_from

Jos jätät sen pois, widget käyttää eilisen päivämäärää. Se ei ole ”koko historia”.

Yli 89 päivän jaksoissa eurooppalaisissa pankeissa laitos voi pyytää ylimääräisen kaksivaiheisen vaiheen. Käyttäjä suorittaa sen widgetissä; luku voi kestää useita minuutteja.

product_types

Mahdolliset arvot:

  • accounts — käyttötilit
  • portfolios — sijoitussalkut
  • cards — kortit
  • receipts — suoraveloitukset
  • loans — lainat
  • deposits — talletukset
  • leases — leasing / vuokraus
  • insurances — vakuutukset
  • factoring
  • confirming
  • properties — kiinteistöt
  • invoices — laskut
  • files — tiedostot (Norma 43, 19, …)

Esimerkki: ["accounts", "cards", "loans"] tai "accounts,cards,loans".

Seuraava vaihe

Kun valitsin näyttää oikealta, jatka iframe-backendiin.

Päivitetty viimeksi