Developers API & Widget
API Reference
FI

IframeVaihe 2/2

Määritä backend

Vastaanota normalisoidut pankkitiedot palvelimellasi ja kuittaa callback oikein.

Suorita ensin frontendin tarkistuslista. Widget ei lähetä pankkidataa postMessage-viestillä: se lähettää sen tänne POST-pyyntönä.

Integraation tarkistuslista

0/4

1. Luo callback-osoite

Julkaise palvelimellasi HTTPS-päätepiste, joka hyväksyy POST-pyynnön JSON-rungolla.

Kun olet käsitellyt tarvitsemasi, vastaa HTTP-koodilla 200 ja seuraavalla JSONilla:

{
    "status": "ok"
}

Jos palautat toisen tilakoodin tai erilaisen JSONin, widget ei ilmoita frontendille, että kulku päättyi onnistuneesti.

Käsittele operation_id idempotenttina: toistunut toimitus ei saa luoda kahta operaatiota järjestelmääsi.

2. Mitä POST-pyynnössä saapuu

Runko on sama JSON kuin POST /entities/ OpenAPI-viitteessä. Kentät, joilla yhdistät operaation:

Kenttä Käyttö
success true, jos luku päättyi onnistuneesti.
payload Normalisoidut tiedot (tilit, salkut, kortit, …).
statistics.operation_id Frontendisi luoma operation_id.
statistics.token Säilötty valtuutus myöhempiä päivityksiä varten (jos tokenisointi on päällä).
statistics.code Laitoskoodi (bbva, caixabank, …).
statistics.SESSION Istuntotunnus, hyödyllinen tukitiketissä.
statistics.warnings Varoitukset, jotka eivät mitätöi lukua (esimerkiksi tyhjä tuote).

Lyhennetty esimerkki:

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

Koko payload-skeema on OpenAPI-kuvauksessa. Älä oleta, että jokainen avain on aina mukana: se riippuu product_types-arvosta ja siitä, mitä käyttäjällä on laitoksessa.

3. Yhdistä domain, callback ja API-avain

Asiakasalueella yhdistä:

  • domain, josta widget ladataan (frontendisi origin);
  • juuri luomasi callback-osoite;
  • api_key-avaimesi.

Kunnes domain on rekisteröity, widget ei toimi.

4. Testaa kulku

Avaa sivu, joka lataa widgetin, ja kirjaudu:

Käyttäjätunnus Salasana Tulos
MOCKDATA mikä tahansa Onnistunut luku anonymisoidulla esimerkkidatalla. Callback vastaanottaa JSONin, jossa success: true.
MOCKOTP mikä tahansa Toistaa kaksivaiheisen haasteen.
MOCKLOGINKO mikä tahansa Toistaa kirjautumisvirheen. Callbackia ei kutsuta.

Jos sinulla ei ole tervetulosähköpostia, pyydä se osoitteesta support@wealthreader.com.

Jos haluat tarkastella POST-pyyntöä ennen kuin päätepisteesi on olemassa, luo tilapäinen URL palvelussa kuten https://pipedream.com/ ja aseta se callbackiksi.

5. Päivitä tiedot (valinnainen)

Tässä vaiheessa sinulla on kerta-ajoinen integraatio: yksi luku joka kerta, kun käyttäjä avaa widgetin.

Jos tarvitset yön yli ajettavan erän tai ”päivitä”-painikkeen, kutsu API:a uudelleen callbackista tallentamillasi token- ja code-arvoilla. Älä kysy käyttäjätunnusta ja salasanaa uudelleen.

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'

Kiinnitä tarkkaa huomiota virhekoodeihin: älä yritä uudelleen virheellisellä salasanalla; voit yrittää uudelleen, kun laitos on huollossa.

Jos token lakkaa toimimasta (salasanan vaihto tai uusi 2FA), avaa widget uudelleen ja välitä kyseinen arvo wr_conf.token-kentässä, jotta käyttäjä voi tunnistautua uudelleen.

Päivitetty viimeksi