404 tant que l’accès en production n’a pas été annoncé, et rien n’est facturé en sandbox.
Ce démarrage rapide vous guide depuis une application sandbox jusqu’aux comptes, soldes et transactions du Didit Test Bank, à l’aide de requêtes prêtes à copier-coller.
Chaque réponse ci-dessous est réduite aux champs essentiels.
Conservez la clé API sur votre serveur : elle n’atteint jamais un navigateur ni une application.
Étape 1 : créer une clé API avec l’autorisation Bank data
Les données bancaires ne font pas partie de l’accès complet. Une clé à accès complet, y compris le secret principal de l’application, est refusée sur chaque appel aux données bancaires avec403 bank_data_access_denied.
- Dans le Business Console, ouvrez votre application sandbox et accédez à API keys.
- Créez une clé avec un accès personnalisé et ajoutez Bank data : Read pour les lectures, Write pour les appels qui créent, modifient ou suppriment quelque chose.
- Copiez la clé et exportez-la :
Étape 2 : créer un lien
Un lien correspond à une exécution des écrans dans lesquels une personne connecte sa banque. Créez un lien continu pour la Test Bank :country est le pays de la banque de la personne, au format à trois lettres, et ce champ est facultatif.
Envoyez-le lorsque vous le connaissez afin que la personne ne voie que les banques de ce pays ; sans lui, elle choisit parmi tous les pays que vous pouvez desservir.
Pour un accès ponctuel, envoyez "access": "one_time" (valeur par défaut).
id du lien avec votre utilisateur.
Les champs url et client_token ne sont renvoyés qu’une seule fois, lors de la création du lien.
Étape 3 : ouvrez le lien et connectez-vous à Didit Test Bank
Ouvrez l’url dans un navigateur, ou envoyez-la à la personne par e-mail ou par messagerie.
La personne voit l’écran de consentement, sélectionne Didit Test Bank, se connecte avec l’un des clients de test et choisit les comptes à partager.
La page sandbox répertorie les clients de test et ce que chacun vous fournit.
Pour renvoyer la personne sur votre site ensuite, consultez Retour vers votre site.
Sans redirect_url, la personne termine sur la page de résultat de Didit et vous obtenez le résultat via le webhook ou en effectuant une lecture.
Étape 4 : recevoir les webhooks et confirmer
Abonnez une destination de webhook aux événementsbank.* dans la console, comme pour tout webhook.
Lorsque la personne termine, bank.link.completed est reçu avec le link_id et le connection_id, puis bank.connection.created une fois que la première synchronisation a enregistré les comptes.
Ne faites jamais confiance à un identifiant de lien envoyé par un navigateur.
Consultez vous-même le lien :
status vaut completed ou un statut final (cancelled, expired, failed). Un lien failed contient un error.code ; un lien cancelled affiche error: null.
Étape 5 : lire les comptes, les soldes et les transactions
next_page_token tant qu’il reste des données à lire.
Consultez Comptes, soldes et transactions.
Étape 6 : suivre le flux des modifications
Le flux des modifications ne renvoie que ce qui a changé depuis votre dernière lecture. Votre première lecture, sans curseur, est l’instantané complet : chaque transaction de la connexion, chacune marquéeadded, avec reset: true.
Une première page peut contenir has_more: true, un next_page_token et pas encore de next_cursor.
Continuez à lire avec page_token tant que has_more vaut true, puis conservez le next_cursor de la dernière page (celle où has_more: false) pour la prochaine lecture :
reset: true signifie que la réponse est un instantané complet : remplacez votre copie par cette réponse au lieu d’y ajouter les données.
bank.data.updated vous indique qu’une synchronisation a enregistré de nouvelles données.
Étape 7 : synchroniser maintenant
Une connexion continue se synchronise automatiquement. Pour lire les données de la banque maintenant, demandez une synchronisation :sync.live_syncs_left_today et sync.budgets de la connexion indiquent combien de lectures sans intervention il reste et quand ces budgets sont réinitialisés. Un appel qui dépasse la limite reçoit la réponse 429 refresh_limit_reached, accompagnée de l’heure de réinitialisation.
Voir Actualiser les données bancaires à la demande.
Étape 8 : arrêter l’accès et supprimer
Arrêter l’accès et supprimer sont deux appels différents.id, status, status_reason, created_at et erasure.
Voir Données, consentement et suppression.
Prochaines étapes
- Connexions : accès ponctuel et continu, consentement et renouvellement.
- Webhooks bancaires
- Tarifs
- Référence API