Developers API & Widget
API Reference
FI

IframeVaihe 1/2

Käyttöliittymän määrittäminen

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 käsittelee vain käyttöliittymää. Callback ja pankkitiedot määritetään taustajärjestelmässä.

Sivun verkkotunnus on valtuutettava asiakasalueella ennen widgetin avaamista. Muussa tapauksessa widget ilmoittaa, ettei verkkotunnusta ole valtuutettu.

Integraation tarkistuslista

0/3

Vähimmäiskoodi

Luo uusi operation_id jokaista operaatiota varten. Jätä entities_to_display tyhjäksi, jotta kaikki api_key-avaimellesi kuuluvat pankit näytetään. Pidä wait_full_response arvossa true, ellei tekninen tiimi ohjeista toisin.

<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") {
            // El callback de backend ya se envió con éxito.
            // Cierra el selector o redirige a la pantalla de éxito.
            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, login incorrecto, callback caído, etc.
            }
        } catch (err) {
            // Ignora otros mensajes del iframe.
        }
    });
</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, jonka tunniste on id="wr-iframe", ja asettaa sen korkeuden ikkunan mukaan. Varaa sille riittävästi pystysuuntaista tilaa; keskelle sivua sijoitettu iframe voi leikkautua.

postMessage-viestit

Iframe viestii sivusi kanssa seuraavasti:

event.data Milloin Toiminta
"flow completed" Tietojen luku onnistui ja callback vastasi 200 + {"status":"ok"} Sulje widget tai siirry onnistumisnäkymään. Viesti ei sisällä pankkitietoja.
JSON, jossa on error Prosessi jatkuu (2FA, sopimus jne.) tai on epäonnistunut Lue error.code ja error.message. Callbackia ei ole lähetetty.

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

wr_conf-parametrit

Parametri Pakollinen Oletusarvo Toiminta
operation_id Kyllä — Itse luomasi tunniste. Se palautuu callbackissa käyttöliittymän ja taustajärjestelmän yhdistämiseksi.
entities_to_display Ei kaikki Pankkikoodien taulukko. Tyhjä tai puuttuva arvo = kaikki. Luettelo: https://api.wealthreader.com/entities/
wait_full_response Ei true true: tuotteet ja tapahtumat. false: vain tuoteluettelo.
date_from Ei eilinen Haettavien tapahtumien aloituspäivä, AAAA-MM-DD. Käytössä vain, jos wait_full_response on true.
product_types Ei api_key-avaimesi tuotteet Tuotesuodatin. Taulukko tai pilkuilla erotettu luettelo.
default_login Ei — Pankkikoodi. Avaa suoraan kyseisen pankin lomakkeen.
default_login_entity_country Ei ES ISO-maakoodi (ES, FR, …). Käytetään vain, jos default_login on annettu.
token Ei — Uudelleentunnistautuminen: esivalitsee pankin tokenista, joka ei enää kelpaa.
psd2 Ei true Näyttää PSD2-pankit. Vain jos et suodata kentällä entities_to_display.
nonpsd2 Ei true Näyttää pankit muun kuin PSD2-kanavan kautta (kattavammat tiedot). Sama rajaus kuin kentällä psd2.
language Ei selaimen kieli "es" tai "en".
tokenize Ei asiakasalueen asetus true palauttaa uudelleenkäytettävän token-arvon callbackissa.
business_account Ei true Sisältää yritysasiakkaiden pankit.
personal_account Ei true Sisältää henkilöasiakkaiden pankit.

wait_full_response

Pidä arvona true. Poistaminen käytöstä lyhentää odotusta sekunneilla, mutta tapahtumat jäävät saamatta. Älä poista asetusta käytöstä ilman selkeää käyttökokemukseen liittyvää syytä. Hae tällöin tapahtumat myöhemmin API:lla ja callbackin token-arvolla.

date_from

Jos et lähetä tätä kenttää, widget käyttää eilistä päivämäärää. Se ei tarkoita koko historiaa.

Kun eurooppalaisesta pankista haetaan yli 89 päivän ajanjaksoa, pankki voi vaatia ylimääräisen kaksivaiheisen tunnistautumisen. Käyttäjä suorittaa sen widgetissä; tietojen luku voi kestää useita minuutteja.

product_types

Mahdolliset arvot:

  • accounts — 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 pankkivalitsin näkyy oikein, jatka iframen taustajärjestelmään.

Päivitetty viimeksi