Une nouvelle version des widgets (V2.1) est maintenant disponible.
La documentation de référence a également été mise à jour et est disponible ici :
https://developers.oxlin.io/reference-accounts-api#tag/manage-widget
Notez que nos widgets précédents (V1.0) sont toujours documentés dans la même section, mais ils sont marqués comme obsolètes.
Vous trouverez ci-dessous plus d'informations sur la migration a effectuer afin de bénéficier de tous les avantages de ces nouveaux widgets.
Les différents flux
Il y a deux principaux changements concernant les flux.
- Dans nos nouveaux widgets, nous allons dans un premier temps prioriser la récupération de vos comptes de paiement, puis de vos comptes d'épargne. Si ces derniers ne sont pas disponibles, un canal alternatif est ensuite proposé à l'utilisateur, lui permettant d'y accéder. Cette dernière étape est facultative et paramétrable.
- Il n'y a plus de point d'entrée de l'API pour accepter les termes et conditions. Ainsi, le point d'entrée '/terms' n'existe plus. Cela est maintenant intégré dans le parcours de l'utilisateur, ce qui le rend beaucoup plus fluide et instinctif: Après avoir choisi la banque, l'utilisateur accède à un écran où il consent et accepte les termes et conditions. Cet écran s'affiche chaque fois que l'utilisateur ajoute une connexion ou se ré-authentifie pour une connexion existante.
Vous pouvez personnaliser ou même ignorer cet écran si vous avez votre propre licence. Pour ce faire, utilisez les paramètres suivants :
-
- Pour contourner l'écran : fournissez le paramètre Terms_body avec une valeur vide
- Pour personnaliser l'écran, vous pouvez utiliser ces deux paramètres :
-
-
-
terms_header -
terms_body
-
-
Les paramètres
Modification des URLs d'accès
Tous les points d'entrée de l'API des nouveaux widgets sont maintenant disponibles avec une URL comportant la version 'v2.1':
-
POST /v2.1/widget/widget_session
-
GET /v2.1/widget/add_connection
-
GET /v2.1/widget/edit_credentials
-
GET /v2.1/widget/user_input
-
GET /v2.1/widget/manage_accounts
Pour l'environnement de sandbox, les chemins d'accès complets sont :
A noter que dans les widgets v2, nous documentons les points d'entrée /add_connection, /manage_accounts, /user_input et /edit_credentials avec des paramètres booléens.
Les valeurs 0 et 1 ne sont plus possibles contrairement aux widgets v1.
Les paramètres modifiés
Endpoint POST /v2.1/widget/widget_session
Il y a maintenant seulement 4 paramètres pour ce point d'entrée::
-
access_token -
refresh_token -
client_id -
client_secret
Leur rôle et leur comportement n'ont pas changé par rapport à la version précédente de nos widgets.
A noter que tous les paramètres fonctionnels doivent maintenant être fournis aux autres points d'entrée de l'API.
Les changements
La description des changements ci-dessous concerne les points d'entrée suivants:
-
GET /v2.1/widget/add_connection
-
GET /v2.1/widget/edit_credential
-
GET /v2.1/widget/user_input
-
GET /v2.1/widget/manage accounts
|
captive_mode |
wait_sync_end |
Aucun changement fonctionnel |
|
redirect_uri |
redirect_url |
Aucun changement fonctionnel |
|
select_accounts |
consent_per_account |
Aucun changement fonctionnel |
|
channel_definition_id / multiple_channels |
expected_account_types |
Description ci-dessous |
Dans nos widgets précédents, vous pouviez utiliser le paramètre 'channel_definition_id' pour cibler un canal spécifique (qui avait un mode EMBEDDED ou REDIRECT).
Vous pouviez également utiliser le paramètre 'multiple_channels' pour récupérer dans un premier temps les comptes de paiement disponibles dans une API PSD2, puis les autres comptes (épargne, crédit) disponibles dans l'interface web de l'établissement bancaire.
Dans nos nouveaux widgets, le paramètre 'expect_account_types' remplace ces deux paramètres. Il y a 3 valeurs possibles :
-
ALL: l'utilisateur peut d'abord ajouter ses comptes de paiement (cartes de crédit et comptes courants), puis il lui sera demandé s'il désire ajouter ses prêts et ses comptes d'épargne. -
PAYMENT: l'utilisateur peut ajouter sa carte de crédit et ses comptes chèques uniquement -
OTHER: l'utilisateur ne peut ajouter que ses prêts et comptes d'épargne
Au niveau de l'API, il vous suffit ainsi de spécifier les types de comptes que vous souhaitez synchroniser et nos nouveaux widgets choisiront et géreront le bon flux pour vous.
Les nouveaux paramètres
|
cancel_url |
URL vers laquelle l'utilisateur sera redirigé s'il annule le processus. Si le 'cancel_url' n'est pas fournie, aucun bouton d'annulation n'est affiché. |
|
congrats_bypass_delay |
C'est le temps d'attente avant que l'utilisateur ne soit redirigé vers la page en 'Success' (redirect_url) à la fin du process. Par défaut : 5 s |
|
countries |
Les widgets affichent uniquement les établissements bancaires des pays concernés. |
|
locale |
Nos nouveaux widgets sont disponibles en français, anglais et italien. Par défaut, le widget prend la langue du navigateur. Ce paramètre permet de forcer la langue. |
|
favorite_providers |
Le widget affiche la liste des établissements bancaires favoris en haut de l'écran. |
Customisation
Nos nouveaux widgets offrent la possibilité de personnaliser plusieurs paramètres. Pour en savoir plus sur les paramètres de personnalisation, vous pouvez consulter notre Guide de customisation V2.
Iframe ou application mobile
Si vous intégrez nos nouveaux widgets dans des Iframes ou dans une application mobile, vous pouvez lire ce guide :
0 Comments