Developers API & Widget
API Reference
FR

IframeÉtape 2 sur 2

Installe l’arrière-plan

Recevez les informations bancaires normalisées sur votre serveur et confirmez correctement le rappel.

Complétez d’abord la checklist du frontend]. Le widget n’envoie pas les coordonnées bancaires par postMessage: il les envoie ici, en utilisant POST.

Checklist d'intégration

0 sur 4

1. Créer l’URL de rappel

Exposez un point de terminaison HTTPS sur votre serveur qui accepte POST avec un corps JSON.

Après traitement au besoin, il répond HTTP 200 avec le JSON suivant :

{
    "status": "ok"
}

Si vous retournez un code d’état différent ou un JSON différent, le widget ne notifiera pas à l’interface que le flux s’est terminé avec succès.

Traiter operation_id comme un idempotent : La livraison répétée ne devrait pas créer deux opérations sur votre système.

2. Ce qui arrive dans le POST

Le corps est le même JSON que POST /entities/ dans la référence OpenAPI. Les éléments importants à franchir dans l’opération :

Champ Application
success true si la lecture s’est bien terminée.
payload Données standardisées (comptes, portefeuilles, cartes, etc.).
statistics.operation_id Celui operation_id qui a généré votre frontend.
statistics.token Accréditation de garde pour les rafraîchissements ultérieurs (si la tokenisation est active).
statistics.code Code d’entité (bbva, caixabank, ...).
statistics.SESSION ID de session, utile dans un ticket de support.
statistics.warnings Des avertissements qui n’invalident pas la lecture (par exemple, un produit vide).

Exemple découpé :

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

Le schéma complet se trouve payload dans l’OpenAPI. Ne supposez pas que toutes les clés sont toujours présentes : elles dépendent de product_types ce que l’utilisateur possède dans l’entité.

3. Domaine associé, rappel et clé API

Dans la section client ] collaborateur :

  • le domaine à partir duquel le widget est chargé (l’origine de votre front) ;
  • l’URL de rappel que vous venez de créer ;
  • Toi api_key.

Tant que le domaine n’est pas enregistré, le widget ne fonctionne pas.

4. Tester le flux

Ouvrez la page qui charge le widget et connectez-vous :

Utilisateur Mot de passe Résultat
MOCKDATA N’importe quel Lecture correcte avec des données d’exemple anonymisées. Le rappel reçoit un JSON success: true.
MOCKOTP N’importe quel Vous recréez un défi à deux facteurs.
MOCKLOGINKO N’importe quel Vous recréez une erreur de connexion. Le rappel n’est pas appelé.

Si vous n’avez pas l’email de bienvenue, demandez-le à support@wealthreader.com.

Si vous souhaitez voir le POST avant d’avoir le point de terminaison dans votre environnement, créez une URL temporaire dans un service comme https://pipedream.com/ et mettez-la en rappel.

5. Données de rafraîchissement (optionnelles)

Pour l’instant, vous avez une intégration one-shot : une lecture à chaque fois que l’utilisateur ouvre le widget.

Si vous avez besoin d’un lot de livraison nocturne ou d’un bouton « mise à jour », rappelez l’API avec celui token et celui code que vous avez sauvegardé depuis le rappel. Ne demandez pas un nouveau nom d’utilisateur et mot de passe.

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'

Faites attention aux codes d’erreur](https://api.wealthreader.com/error-codes/) : un mot de passe invalide n’est pas réessayé ; une maintenance d’entité l’est.

Si le changement de mot de passe ou la token nouvelle 2FA devient invalide, ouvrez à nouveau le widget en passant cette valeur wr_conf.token à l’utilisateur pour qu’elle puisse la réauthentifier. /support@wealthreader.com

Dernière mise à jour