Developers API & Widget
API Reference
GA

IframeCéim 1 de 2

Cumraigh an frontend

Leabaigh an widget i do leathanach, taispeáin roghnóir na mbanc agus éist le teachtaireachtaí an iframe.

Is iframe é an widget a luchtaítear le https://widget.wealthreader.com/js/load.js. Clúdaíonn an leathanach seo an frontend amháin. Cumraítear an callback agus sonraí an bhainc sa backend.

Ní mór an fearann a sheolann an leathanach seo a bheith údaraithe i limistéar na gcliant sula n-osclaíonn tú an widget. Seachas sin tuairiscíonn an widget nach bhfuil an fearann údaraithe.

Seicliosta comhtháthaithe

0 as 3

Íoschód

Gin operation_id nua do gach oibríocht. Fág entities_to_display folamh chun gach institiúid ar do api_key a thaispeáint. Coinnigh wait_full_response ar true mura ndeir an fhoireann theicniúil a mhalairt leat.

<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>

Lorgaíonn load.js an iframe le id="wr-iframe" agus socraíonn sé a airde de réir an viewport. Tabhair spás ingearach dó; má chuireann tú i lár an leathanaigh é, d’fhéadfadh sé a bheith bearrtha.

Teachtaireachtaí postMessage

Labhraíonn an iframe le do leathanach mar seo:

event.data Cathain Cad atá le déanamh
"flow completed" Chríochnaigh an léamh go rathúil agus d’fhill do callback 200 + {"status":"ok"} Dún an widget nó téigh chuig an scáileán ratha. thaistealaíonn sonraí an bhainc sa teachtaireacht seo.
JSON le error Tá an sreabhadh fós ar siúl (2FA, conradh, srl.) nó theip air Léigh error.code agus error.message. Níor seoladh an callback.

Seiceáil i gcónaí event.origin === "https://widget.wealthreader.com".

Paraiméadair wr_conf

Paraiméadar Riachtanach Réamhshocrú Cad a dhéanann sé
operation_id Aitheantas a ghineann tú. Filleann sé sa callback ionas gur féidir leat an frontend agus an backend a mheaitseáil.
entities_to_display Níl uile Eagar de chóid institiúide. Folamh nó fágtha ar lár = uile. Liosta: https://api.wealthreader.com/entities/
wait_full_response Níl true true: táirgí agus idirbhearta. false: liosta na dtáirgí amháin.
date_from Níl inné Tús na n-idirbheart, YYYY-MM-DD. Ní bhaineann sé ach nuair atá wait_full_response ar true.
product_types Níl iad siúd ar do api_key Scagaire táirgí. Eagar nó liosta scartha le camóga.
default_login Níl Cód institiúide. Osclaíonn sé foirm na hinstitiúide sin go díreach.
default_login_entity_country Níl ES Cód tíre ISO (ES, FR, …). Ní úsáidtear é ach nuair atá default_login socraithe.
token Níl Athfhíordheimhniú: réamhroghnaíonn sé banc an token nach bhfuil bailí a thuilleadh.
psd2 Níl true Taispeáin institiúidí PSD2. Ach amháin mura scagann tú le entities_to_display.
nonpsd2 Níl true Taispeáin institiúidí ar an gcainéal neamh-PSD2 (sonraí níos saibhre). An coinníoll céanna le psd2.
language Níl teanga an bhrabhsálaí "es""en".
tokenize Níl socrú limistéar na gcliant true chun token in-athúsáidte a fháil sa callback.
business_account Níl true Cuir institiúidí gnó san áireamh.
personal_account Níl true Cuir institiúidí pearsanta san áireamh.

wait_full_response

Fág ar true é. Giorraíonn é a mhúchadh an fanacht (soicindí) ar chostas gan idirbhearta a fháil. Ná díchumasaigh é mura bhfuil cúis shoiléir UX agat, agus ansin faigh na hidirbhearta níos déanaí leis an API agus an token ón callback.

date_from

Má fhágann tú ar lár é, úsáideann an widget dáta an lae inné. Ní hé sin “an stair iomlán”.

I gcás raonta níos faide ná 89 lá ag bainc Eorpacha, féadfaidh an institiúid céim bhreise dhá fhachtóir a iarraidh. Comhlánaíonn an t-úsáideoir í sa widget; is féidir leis an léamh roinnt nóiméad a thógáil.

product_types

Luachanna féideartha:

  • accounts — cuntais reatha
  • portfolios — punanna infheistíochta
  • cards — cártaí
  • receipts — dochair dhíreacha
  • loans — iasachtaí
  • deposits — taiscí
  • leases — léasú / cíos
  • insurances — árachas
  • factoring
  • confirming
  • properties — eastát réadach
  • invoices — sonraisc
  • files — comhaid (Norma 43, 19, …)

Sampla: ["accounts", "cards", "loans"]"accounts,cards,loans".

An chéad chéim eile

Nuair a bhreathnaíonn an roghnóir i gceart, lean ar aghaidh leis an backend iframe.

Nuashonraithe