Developers API & Widget
API Reference
DE
ES · EspañolEN · EnglishFR · FrançaisCA · CatalàDA · DanskDE · DeutschEL · ΕλληνικάFI · SuomiGA · GaeilgeIT · ItalianoJA · 日本語NL · NederlandsNO · NorskPT · PortuguêsRO · RomânăRU · РусскийZH · 中文

IframeSchritt 1 von 2

Richte das Frontend auf

Einbetten Sie das Widget auf Ihrer Seite, zeigen Sie den Bankpicker an und hören Sie sich die Nachrichten des iframe an.

Das Widget ist ein iframe, das mit https://widget.wealthreader.com/js/load.jslädt. Diese Seite behandelt nur die Vorderseite. Die Rückruf- und Bankdaten sind auf Backend] gesetzt.

Die Domain, von der aus Sie diese Seite bereitstellen, muss in dem Client-Bereich vor Öffnen des Widgets autorisiert sein. Wenn nicht, antwortet das Widget, dass die Domain nicht autorisiert ist.

Integrations-Checkliste

0 von 3

Mindestcode

Generiere in jeder Operation eine operation_id neue. Lass entities_to_display leer, um alle Entitäten in deinem api_keyanzuzeigen. Halte dich wait_full_response true vor dem technischen Team sicher, das dir etwas anderes sagt.

<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 Es sucht nach dem iframe mit id="wr-iframe" und weist ihm die Höhe entsprechend dem Fenster zu. Positioniere ihn so, dass er vertikalen Platz hat; Wenn du es in die Mitte der Seite einfügst, kann es beschnitten werden.

Nachrichten postMessage

Der iframe spricht so mit deiner Seite:

event.data Wenn Dinge zu tun
"flow completed" Die Lesung endete gut und dein Rückruf hat 200 geantwortet + {"status":"ok"} Schließe das Widget oder gehe zum Erfolgsbildschirm. Nein die Bankdaten in dieser Nachricht.
JSON mit error Der Fluss setzt sich fort (2FA, Vertrag usw.) oder ist gescheitert Lesen error.code und error.message. Der Rückruf wurde noch nicht gesendet.

Immer event.origin === "https://widget.wealthreader.com"überprüfen.

Parameter von wr_conf

Parameter Erforderlich Standard Was es bewirkt
operation_id Ja — Ich weiß, dass du es generierst. Kehre beim Rückruf zurück, um vorne und hinten zu kreuzen.
entities_to_display Ja Alle Array von Entitätscodes. Leere oder abwesend = alle. Auflistung: https://api.wealthreader.com/entities/
wait_full_response Ja true true : Produkte und Transaktionen. false: nur die Liste der Produkte.
date_from Ja gestern Einleitung von Transaktionen, AAAA-MM-DD. gilt nur, wenn wait_full_response es . true
product_types Ja api_key Deine Produktfilter. Array- oder kommagetrennte Liste.
default_login Ja — Entitätscode. Öffne die Form dieser Entität direkt.
default_login_entity_country Ja ES ISO-Ländercode (ES, FR, ...). Wird nur verwendet, wenn es default_login.
token Ja — Re-Authentifizierung: Wählt die Bank vorab aus einem Token aus, der nicht mehr gültig ist.
psd2 Ja true Zeigt PSD2-Entitäten an. Nur wenn du nicht mit entities_to_display. filterst.
nonpsd2 Ja true Zeigt Entitäten pro Nicht-PSD2-Kanal an (ausführlichere Informationen). Gleiche Nuance wie psd2.
language Ja Die mit dem Browser "es" oder "en".
tokenize Ja Der im Kundenbereich true Um ein token wiederverwendbares Exemplar im Rückruf zu bekommen.
business_account Ja true Umfasst Unternehmenseinheiten.
personal_account Ja true Es umfasst Entitäten von Individuen.

wait_full_response

Lass es bei true. Das Ausschalten verkürzt die Wartezeit (Sekunden), allerdings ohne Transaktionen. Deaktiviere es nicht, es sei denn, es gibt einen klaren UX-Grund, und rufe die Transaktionen später mit der API und dem token Callback ab.

date_from

Wenn du es nicht verschickst, verwendet das Widget das Datum von gestern. Es ist nicht "die ganze Geschichte".

Bei Fristen von mehr als 89 Tagen kann das Unternehmen bei europäischen Banken einen zusätzlichen Doppelfaktor verlangen. Der Benutzer vervollständigt es im Widget; Das Lesen kann mehrere Minuten dauern.

product_types

Mögliche Werte:

  • accounts — Berichte
  • portfolios — Anlageportfolios
  • cards — Karten
  • receipts — Quittungen
  • loans — Kredite
  • deposits — Ablagerungen
  • leases — Vermietung / Vermietung
  • insurances — Versicherung
  • factoring
  • confirming
  • properties — Immobilien
  • invoices — Rechnungen
  • files — Akten (Regel 43, 19, ...)

Beispiel: ["accounts", "cards", "loans"] oder "accounts,cards,loans".

Nächster Schritt

Wenn der Selektor gut aussieht, folgt mit iframe Backend.

Zuletzt aktualisiert