Developers API & Widget
API Reference
GA

IframeCéim 2 de 2

Cumraigh an backend

Faigh na sonraí baincéireachta normalaithe ar do fhreastalaí agus deimhnigh an callback i gceart.

Críochnaigh seicliosta an frontend ar dtús. Ní sheolann an widget na sonraí bainc trí postMessage: seolann sé anseo iad, mar POST.

Seicliosta comhtháthaithe

0 as 4

1. Cruthaigh URL an callback

Nocht críochphointe HTTPS ar do fhreastalaí a ghlacann le POST le corp JSON.

Tar éis duit an méid is gá a phróiseáil, freagair HTTP 200 leis an JSON seo a leanas:

{
    "status": "ok"
}

Má fhilleann tú cód stádais eile nó JSON difriúil, ní chuirfidh an widget in iúl don frontend gur chríochnaigh an sreabhadh i gceart.

Déileáil le operation_id mar luach idéampóiteach: níor chóir do sheachadadh athdhéanta dhá oibríocht a chruthú i do chóras.

2. Cad a thagann sa POST

Is é an corp an JSON céanna le POST /entities/ sa tagairt OpenAPI. Réimsí a theastaíonn uait chun an oibríocht a mheaitseáil:

Réimse Úsáid
success true má chríochnaigh an léamh go rathúil.
payload Sonraí normalaithe (cuntais, punanna, cártaí, …).
statistics.operation_id An operation_id a ghin do frontend.
statistics.token Dintiúr coimeádta le haghaidh athnuachan níos déanaí (má tá tokenisation ar siúl).
statistics.code Cód na hinstitiúide (bbva, caixabank, …).
statistics.SESSION Aitheantas an tseisiúin, úsáideach i dticéad tacaíochta.
statistics.warnings Rabhaidh nach gcuireann an léamh ar neamhní (mar shampla táirge folamh).

Sampla giorraithe:

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

Tá scéimre iomlán an payload san OpenAPI. Ná glac leis go mbíonn gach eochair i láthair i gcónaí: braitheann sé ar product_types agus ar a bhfuil ag an úsáideoir san institiúid.

3. Ceangail fearann, callback agus eochair API

I limistéar na gcliant ceangail:

  • an fearann óna luchtaítear an widget (origin do frontend);
  • URL an callback a chruthaigh tú;
  • do api_key.

Go dtí go bhfuil an fearann cláraithe, ní oibríonn an widget.

4. Tástáil an sreabhadh

Oscail an leathanach a luchtaíonn an widget agus logáil isteach:

Ainm úsáideora Pasfhocal Toradh
MOCKDATA aon rud Léamh rathúil le sonraí samplacha anaithnidithe. Faigheann an callback JSON le success: true.
MOCKOTP aon rud Athchruthaíonn dúshlán dhá fhachtóir.
MOCKLOGINKO aon rud Athchruthaíonn earráid logála isteach. Ní ghlaoitear an callback.

Mura bhfuil an ríomhphost fáilte agat, iarr é ag support@wealthreader.com.

Más mian leat an POST a iniúchadh sula mbíonn do chríochphointe ann, cruthaigh URL sealadach ar sheirbhís mar https://pipedream.com/ agus socraigh é mar an callback.

5. Athnuaigh sonraí (roghnach)

Ag an bpointe seo tá comhtháthú one-shot agat: léamh amháin gach uair a osclaíonn an t-úsáideoir an widget.

Más gá baisc oíche nó cnaipe “nuashonraigh”, glaoigh ar an API arís leis an token agus an code a stóráil tú ón callback. Ná hiarr an t-ainm úsáideora agus an pasfhocal arís.

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'

Tabhair aird ghéar ar na cóid earráide: ná déan iarracht eile ar phasfhocal neamhbhailí; féadfaidh tú iarracht eile a dhéanamh nuair atá an institiúid faoi chothabháil.

Má stopann an token ag obair (athrú pasfhocail nó 2FA nua), oscail an widget arís agus an luach sin á chur ar aghaidh in wr_conf.token ionas gur féidir leis an úsáideoir fíordheimhniú arís.

Nuashonraithe