Developers API & Widget
API Reference
FR

Premiers pas

Flux d’intégration

Déroulement nominal d’une intégration par iframe. Le rappel est envoyé avant d’avoir notifié le frontend.

sequenceDiagram
participant U as Utilisateur
participant W as Votre site web
participant WG as Wealth Reader Widget
participant API as Wealth Reader API
participant B as Institution financière
U->>W: Ouvre l’application
W->>WG: Insérez le iframe avec operation_id
U->>WG: Choisissez l’entité et donnez votre consentement
WG->>API: Demandez les données avec operation_id
API->>B: Demandez les détails du compte
B-->>API: Restitue les données brutes
API-->>WG: Restitue les données normalisées
WG->>W: Envoyez un POST au callback (operation_id + token + payload)
W-->>WG: Répondez HTTP 200 et status ok
WG-->>W: Envoie postMessage flow completed
W-->>U: Affiche l’écran de réussite

Qui fait quoi

Acteur Responsabilité
Votre front-end Générez un operation_id unique, chargez le widget et écoutez postMessage.
Le widget Il affiche les banques, la connexion, la 2FA et les erreurs à l’utilisateur.
L’API de Wealth Reader Parle à l’entité et normalise la réponse.
Votre backend Expose l’URL de rappel, répond {"status":"ok"} , et sauvegarde operation_id, token et payload.

Si quelque chose tourne mal

  • Mot de passe incorrect, 2FA ou erreur d’entité : le widget résout cela avec l’utilisateur. Votre front peut recevoir une erreur JSON pour postMessage; le rappel n’est appelé que lorsque la lecture s’est bien terminée.
  • Votre rappel ne répond pas 200 + {"status":"ok"}: l’utilisateur ne voit pas de succès et le front ne reçoit pas flow completed.
  • Un token n’est plus valable (changement de mot de passe, nouvelle 2FA) : rouvrir le widget en passant ce token pour que l’utilisateur puisse se réauthentifier.

Le détail de chaque message et le corps du rappel se trouvent sur les pages iframe.

Étape suivante

Si vous intégrez par iframe, continuez par Frontend et puis Backend. Si vous ne pouvez pas intégrer un iframe, allez à OAuth.

Dernière mise à jour