Console Try-it

Principe

En vous connectant sur le portail, vous pouvez :

  • faire appel à l'API souhaitée via un formulaire dans lequel vous sélectionnez votre application et le jeton d'accès
  • puis vous saisissez les paramètres de la méthode que vous souhaitez tester (soit headers, soit body), ceux mentionnés par une étoile étant obligatoires

Une fois les paramètres saisis, vous pouvez lancer l'exécution de la requête : vous obtiendrez soit un résultat, soit une erreur.

Pour les méthodes "GET /accounts/transactions" et "GET /accounts/balances", vous devez d'abord exécuter la requête "GET /accounts" pour récupérer la liste des comptes de dépôt ou courant. Cela vous permet de récupérer le "ressourceId" nécessaire pour passer ces méthodes pour le compte.

Les données utilisées pour faire le test en Try-it sont issues de persona (voir la rubrique "Comment tester l'API ?" > "Tester nos personas").

 

➤ Paramètres du Try-it pour chacune des méthodes de l'API "Information sur compte"

NB : pour les paramètres de type de données "body", il est possible de copier-coller les exemples (partie gauche de l'écran) dans le formulaire (à droite de l'écran) en changeant juste les valeurs spécifiques au client choisi.

 

➤ Paramètres communs à toutes les méthodes de l'API "Information sur compte"

ParamètreDescriptionType de donnéesType de paramètreObligatoire
Authorization Jeton d'accès devant être fourni comme header Chaîne de caractères Header Oui
PSU-IP-Address

Adresse IP utilisés par le client connecté sur votre application

(*) Donnée obligatoire si le client est connecté ou non renseignée en cas d'accès batch
Chaîne de caractères Header Non*
PSU-IP-Port Port IP du terminal utilisé par le client connecté sur votre application Chaîne de caractères Header Non
PSU-HTTP-Method Méthode http utilisée pour la requête du client Chaîne de caractères Header Non
PSU-Date Timestamp utilisé par la requête du client Chaîne de caractères Header Non
PSU-GEO-Location Localisation géographique que le client vous a fournie via son terminal si elle est disponible Chaîne de caractères Header Non
PSU-User-Agent Header "User-Agent" envoyé par le terminal du client connecté à votre application Chaîne de caractères Header Non
PSU-Referer Header "Referer" envoyée par le terminal du client connecté à votre application. Il est à noter que dans des spécifications antérieures des RFC 1945, on préconise le nom "referer" (mal orthographié). Le nom "referrer" peut être utilisé au risque de ne pas être compris. Chaîne de caractères Header Non
PSU-Accept Header "Accept" envoyé par le terminal du client connecté à votre application Chaîne de caractères Header Non
PSU-Accept-Charset Header "Accept-Charset" envoyé par le terminal du client connecté à votre application. Chaîne de caractères Header Non
PSU-Accept-Encoding Header "Accept-Encoding" envoyé par le terminal du client connecté à votre application. Chaîne de caractères Header Non
PSU-Accept-Language Header "Accept-Language" envoyé par le terminal du client connecté à votre application. Chaîne de caractères Header Non
Digest Synthèse du body Chaîne de caractères Header Non
Signature

Signature http de la requête (voir https://datatracker.ietf.org/doc/draft-cavage-http-signatures/) La partie keyId du header devrait avoir le format suivant keiId="SN=XXX,CA=YYYYYYYYYYYYYYYY" où "XXX" est le numéro de série en hexadécimal sans aucun préfixe (comme 0x, du certificat QSEAL dont la clé privée a servi pour la signature de celui-ci

"YYYYYYYYYYYYYYYY" est l'émetteur DN,  nom complet de l'autorité de certification ayant émis ce certificat HTTP400 et qui sera renvoyé par le serveur dans le cas d'une signature invalide ou absente.
Chaîne de caractères Header Oui
X-Request-ID Header de corrélation à paramétrer dans la requête et devant être récupéré dans la réponse de celle-ci Chaîne de caractères Header Oui



➤ Paramètres propres à la méthode "Obtenir les soldes d'un compte" - GET accounts/{}/balances

ParamètreDescriptionType de donnéesType de paramètreObligatoire
accountResourceId Identification de la ressource utilisée comme critère principal dans la requête. Il est récupéré via le résultat de la requête "GET /accounts" dans la rubrique "ressourceId", soit pour un compte à vue tel que "accountId": {"iban":"" } Chaîne de caractères Chemin Oui



➤ Paramètres propres à la méthode "Obtenir les transactions d'un compte pour obtenir la liste des comptes" - GET /accounts/{}/transactions

ParamètreDescriptionType de donnéesType de paramètreObligatoire
accountResourceId Identification de la ressource utilisée comme critère principal dans la requête. Il est récupéré via le résultat de la requête "GET /accounts" dans la rubrique "ressourceId" soit pour un compte à vue tel que "accountId": {"iban":"" } Chaîne de caractères Chemin Oui
dateTo Date inclusive minimale d'imputation des transactions. Les transactions ayant une date d'imputation égale à ce paramètre sont inclues dans le résultat de la requête Chaîne de caractères Requête Non
dateFrom

Date exclusive maximale d'imputation des transactions. Les transactions ayant une date d'imputation égale à ce paramètre sont exclues du résultat de la requête

Chaîne de caractères Requête Non
afterEntryReference Ce paramètre fournit la valeur du critère qui déterminera le résultat de la requête. Seules les transactions ayant un identifiant technique supérieur à la valeur fournie seront inclues dans le résultat Chaîne de caractères Requête Non