Developers API & Widget
API Reference
NO

IframeTrinn 1 av 2

Konfigurer frontenden

Sett inn widgeten på siden din, vis bankvelgeren og lytt til meldingene fra iframen.

Widgeten er en iframe som lastes med https://widget.wealthreader.com/js/load.js. Denne siden dekker bare frontenden. Callback og bankdata konfigureres i backend.

Domenet som serverer denne siden, må være autorisert i kundeområdet før du åpner widgeten. Ellers melder widgeten at domenet ikke er autorisert.

Integrasjonssjekkliste

0 av 3

Minimumskode

Generer en ny operation_id for hver operasjon. La entities_to_display være tom for å vise alle institusjoner på api_key-en din. Behold wait_full_response satt til true med mindre det tekniske teamet sier noe annet.

<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 slår opp iframen med id="wr-iframe" og setter høyden ut fra viewporten. Gi den vertikal plass; hvis du plasserer den midt på siden, kan den bli klippet.

postMessage-meldinger

Iframen snakker til siden din slik:

event.data Når Hva du skal gjøre
"flow completed" Lesingen er fullført og callbacken din returnerte 200 + {"status":"ok"} Lukk widgeten, eller gå til suksessskjermen. Bankdata følger ikke med i denne meldingen.
JSON med error Flyten pågår fortsatt (2FA, kontrakt osv.), eller den feilet Les error.code og error.message. Callbacken er ikke sendt.

Sjekk alltid event.origin === "https://widget.wealthreader.com".

Parametere for wr_conf

Parameter Påkrevd Standard Hva den gjør
operation_id Ja Id du genererer. Den kommer tilbake i callbacken, slik at du kan knytte frontend og backend.
entities_to_display Nei alle Array med institusjonskoder. Tom eller utelatt = alle. Liste: https://api.wealthreader.com/entities/
wait_full_response Nei true true: produkter og transaksjoner. false: bare produktlisten.
date_from Nei i går Start for transaksjoner, YYYY-MM-DD. Gjelder bare når wait_full_response er true.
product_types Nei de på api_key-en din Produktfilter. Array eller kommaseparert liste.
default_login Nei Institusjonskode. Åpner skjemaet til den institusjonen direkte.
default_login_entity_country Nei ES ISO-landkode (ES, FR, …). Brukes bare når default_login er satt.
token Nei Ny autentisering: forhåndsvelger banken til et token som ikke lenger er gyldig.
psd2 Nei true Vis PSD2-institusjoner. Bare hvis du ikke filtrerer med entities_to_display.
nonpsd2 Nei true Vis institusjoner på non-PSD2-kanalen (rikere data). Samme forbehold som psd2.
language Nei nettleserspråket "es" eller "en".
tokenize Nei innstillingen i kundeområdet true for å motta et gjenbrukbart token i callbacken.
business_account Nei true Ta med bedriftsinstitusjoner.
personal_account Nei true Ta med privatinstitusjoner.

wait_full_response

La den stå på true. Hvis du slår den av, blir ventetiden kortere (sekunder) på bekostning av at du ikke får transaksjoner. Ikke slå den av med mindre du har en klar UX-grunn, og hent da transaksjoner senere med API-et og token fra callbacken.

date_from

Hvis du utelater den, bruker widgeten gårsdagens dato. Det er ikke «hele historikken».

For perioder lenger enn 89 dager hos europeiske banker kan institusjonen be om et ekstra tofaktorsteg. Brukeren fullfører det i widgeten; lesingen kan ta flere minutter.

product_types

Mulige verdier:

  • accounts — brukskontoer
  • portfolios — investeringsporteføljer
  • cards — kort
  • receipts — AvtaleGiro / faste trekk
  • loans — lån
  • deposits — innskudd
  • leases — leasing / renting
  • insurances — forsikringer
  • factoring
  • confirming
  • properties — eiendom
  • invoices — fakturaer
  • files — filer (Norma 43, 19, …)

Eksempel: ["accounts", "cards", "loans"] eller "accounts,cards,loans".

Neste steg

Når velgeren ser riktig ut, fortsett med iframe backend.

Sist oppdatert