Developers API & Widget
API Reference
NO

IframeTrinn 2 av 2

Sett opp backend

Motta de normaliserte bankopplysningene på serveren din og bekreft callbackkorrekt.

Fullfør Frontend-sjekkliste. Widgeten sender ikke bankdetaljer per postMessage– den sender dem hit, ved å bruke POST.

Integrasjonssjekkliste

0 av 4

1. Opprett callback-URL-en

Eksponer et HTTPS endepunkt på serveren din som aksepterer POST med en body JSON.

Etter å ha behandlet det som er nødvendig, svar HTTP 200 med følgende JSON:

{
    "status": "ok"
}

Hvis du returnerer en annen statuskode eller en annen JSON , vil widgeten ikke varsle frontend om at flyten ble fullført.

Behandle operation_id som idempotent: Gjentatt levering bør ikke skape to operasjoner på systemet ditt.

2. Hva kommer i POST

Kroppen er den samme JSON som POST /entities/ i OpenAPI-referanse. De viktige tingene å krysse operasjonen:

Felt Anvendelse
success true om opplesningen endte bra.
payload Standardiserte data (kontoer, lommebøker, kort, osv.).
statistics.operation_id operation_id som frontenden din genererte.
statistics.token Oppbevaringslegitimasjon for senere dataoppdateringer (hvis tokenisering er aktiv).
statistics.code Entitetskode (bbva, caixabank, ...).
statistics.SESSION Sesjons-ID, nyttig i en supporthenvendelse.
statistics.warnings Advarsler som ikke ugyldiggjør avlesningen (for eksempel et tomt produkt).

Utklippseksempel:

{
    "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"
    }
}

Hele payload -skjemaet finnes i OpenAPI. Ikke anta at alle nøkler alltid kommer inn: de avhenger av product_types og hva brukeren har i enheten.

3. Assosiert domene, callback og API nøkkel

I Kundeområde Assosiert:

  • domenet som widgeten lastes fra (opprinnelsen til fronten din);
  • URL-en til callback du nettopp opprettet;
  • Din api_key.

Inntil domenet er registrert, fungerer ikke widgeten.

4. Test flyten

Åpne siden som laster inn widgeten og logg inn:

Bruker Passord Resultat
MOCKDATA Hvilken som helst Vellykket lesing med anonymiserte prøvedata. callback mottar en JSON success: true.
MOCKOTP Hvilken som helst Du gjenskaper en tofaktorutfordring.
MOCKLOGINKO Hvilken som helst Du gjenskaper en innloggingsfeil. callback blir ikke kalt.

Hvis du ikke har velkomstmailen, be om den på support@wealthreader.com.

Hvis du vil se POST før du har endepunktet i miljøet ditt, opprett en midlertidig URL i en tjeneste som https://pipedream.com/ og si det som callback.

5. Oppdateringsdata (valgfritt)

Så langt har du en one-shot-integrasjon: én lesing for hver gang brukeren åpner widgeten.

Hvis du trenger en nattlig batch eller en «oppdater»-knapp, ring API igjen med token og code du lagret fra callback. Ikke be om nytt brukernavn og passord.

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

Følg med på Feilkoder: Et ugyldig passord prøves ikke på nytt; en enhetsvedlikehold blir det.

Hvis token ikke lenger er gyldig (passordendring eller ny 2FA), åpne widgeten igjen ved å sende den verdien i wr_conf.token slik at brukeren kan autentisere på nytt.

Sist oppdatert