Developers API & Widget
API Reference
NO

IframeTrinn 2 av 2

Konfigurer backenden

Motta de normaliserte bankdataene på serveren din og bekreft callbacken riktig.

Fullfør frontend-sjekklisten først. Widgeten sender ikke bankdataene via postMessage: den sender dem hit, som en POST.

Integrasjonssjekkliste

0 av 4

1. Opprett callback-URL-en

Eksponer et HTTPS-endepunkt på serveren din som tar imot POST med en JSON-body.

Når du har behandlet det du trenger, svar HTTP 200 med følgende JSON:

{
    "status": "ok"
}

Hvis du returnerer en annen statuskode eller en annen JSON, varsler ikke widgeten frontenden om at flyten ble fullført riktig.

Behandle operation_id som idempotent: en gjentatt leveranse skal ikke opprette to operasjoner i systemet ditt.

2. Hva som kommer i POST-en

Bodyen er den samme JSON-en som POST /entities/ i OpenAPI-referansen. Felter du trenger for å knytte operasjonen:

Felt Bruk
success true hvis lesingen ble fullført.
payload Normaliserte data (kontoer, porteføljer, kort, …).
statistics.operation_id operation_id som frontenden din genererte.
statistics.token Oppbevarte innloggingsopplysninger for senere oppdateringer (hvis tokenisering er på).
statistics.code Institusjonskode (bbva, caixabank, …).
statistics.SESSION Økt-id, nyttig i en supportsak.
statistics.warnings Advarsler som ikke gjør lesingen ugyldig (for eksempel et tomt produkt).

Forkortet eksempel:

{
    "success": true,
    "payload": {
        "user_information": {
            "ID": "12345678Z",
            "name": "LUIS GARCIA BAQUERO"
        },
        "accounts": [
            {
                "uuid": "8076932f04f73e27fe608fee4d12fca8708dec8c",
                "subtype": "checking",
                "code": "ES4914651234561234567890",
                "name": "Cuenta NOMINA",
                "currency": "EUR",
                "balances": {
                    "available": 14302.07,
                    "current": 14302.07
                },
                "transactions": []
            }
        ]
    },
    "statistics": {
        "SESSION": "A1B2C3D4E5F67890",
        "execution_time": 12.4,
        "warnings": [],
        "operation_id": "8f1c2a6e-4b0d-4c3a-9e21-0d5b7a91c4e2",
        "token": "FRJ0mHlaqZwLzu",
        "code": "bbva"
    }
}

Det fulle payload-skjemaet står i OpenAPI. Ikke anta at alle nøkler alltid er der: det avhenger av product_types og av hva brukeren har hos institusjonen.

3. Knytt domene, callback og API-nøkkel

I kundeområdet knytter du:

  • domenet widgeten lastes fra (origin til frontenden din);
  • callback-URL-en du nettopp opprettet;
  • api_key-en din.

Inntil domenet er registrert, virker ikke widgeten.

4. Test flyten

Åpne siden som laster widgeten, og logg inn:

Brukernavn Passord Resultat
MOCKDATA hva som helst Vellykket lesing med anonymiserte eksempeldata. Callbacken mottar JSON med success: true.
MOCKOTP hva som helst Gjenskaper en tofaktor-challenge.
MOCKLOGINKO hva som helst Gjenskaper en innloggingsfeil. Callbacken kalles ikke.

Hvis du ikke har velkomst-e-posten, be om den på support@wealthreader.com.

Hvis du vil inspisere POST-en før endepunktet ditt finnes, opprett en midlertidig URL hos en tjeneste som https://pipedream.com/ og sett den som callback.

5. Oppdater data (valgfritt)

På dette tidspunktet har du en engangs-integrasjon: én lesing hver gang brukeren åpner widgeten.

Hvis du trenger en nattlig batch eller en «Oppdater»-knapp, kall API-et på nytt med token og code du lagret fra callbacken. Ikke spør om brukernavn og passord på nytt.

curl --location 'https://api.wealthreader.com/entities/' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'api_key=YOUR_API_KEY' \
  --data-urlencode 'code=bbva' \
  --data-urlencode 'token=TOKEN_FROM_CALLBACK' \
  --data-urlencode 'product_types=accounts,portfolios'

Følg nøye med på feilkodene: ikke prøv på nytt ved ugyldig passord; du kan prøve på nytt når institusjonen er under vedlikehold.

Hvis token slutter å virke (passordendring eller en ny 2FA), åpne widgeten på nytt og send den verdien i wr_conf.token, slik at brukeren kan autentisere seg på nytt.

Sist oppdatert