Tester l'API en Sandbox Try-it

Version 1.4.2

A compter du 8 juillet 2020, le try-it ne sera possible que pour la version V1.4.2.

Si vous avez déjà effectué une demande de GoLive, vous devez alors créer une nouvelle application, puis sélectionner la nouvelle API STET V1.4.2.

Si vous n’avez PAS effectué de demande de GoLive, vous pouvez :

  • soit modifier votre application existante pour l’associer à la nouvelle API STET V1.4.2.
  • soit créer une nouvelle application, puis sélectionner la nouvelle API STET V1.4.2.

 

➤ Schéma Sandbox/Try-it

 

L'utilisateur va faire appel à l'API via un formulaire (TRY-IT - sur la gauche de l'écran) dans lequel il va sélectionner une application, un jeton d'authentification/d'accès et saisir des paramètres. Ceux mentionnés par une étoile sont obligatoires.

Une fois les paramètres saisis, l'utilisateur peut lancer l'exécution de la requête. Il obtiendra en résultat soit une information valide, soit une erreur.

L'utilisateur peut enchaîner les requêtes.

Les données utilisées pour faire le test en Try-It sont issues de jeux de tests restreints.

Aperçu écran de génération du jeton Oauth2

 

Cet écran est accessible lorsque l'on édite l'application (dsp2 dans notre cas) et il permet de générer ou éditer un jeton Oauth2 que l'on sélectionnera dans le formulaire d'exécution Try-It.

 Aperçu du formulaire d'exécution Try-It

 

 

Voici les descriptions des différents paramètres (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è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é par le PSU lors de la connexion au TPP

*obligatoire si le client est connecté mais non renseignée en cas d'accès batch

chaîne de caractères Header non*
PSU-IP-Port Port IP utilisé par le PSU lors de la connexion au TPP chaîne de caractères Header non
PSU-HTTP-Method Méthode http utilisée lors de la requête la plus pertinente faite par le PSU vers le TTP chaîne de caractères Header non
PSU-Date Timestamp utilisé lors de la requête la plus pertinente faite par le PSU vers le TTP chaîne de caractères Header non
PSU-GEO-Location Localisation géographique du PSU fournie par le terminal mobile du PSU au TPP si elle existe chaîne de caractères Header non
PSU-User-Agent Header "User-Agent" envoyé par le PSU lors de la connexion au TPP chaîne de caractères Header non
PSU-Referer Header "Referer" envoyée par le PSU lors de la connexion au TPP. 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 PSU au TPP lors de la connexion chaîne de caractères Header non
PSU-Accept-Charset Header "Accept-Charset" envoyé par le PSU au TPP lors de la connexion chaîne de caractères Header non
PSU-Accept-Encoding Header "Accept-Encoding" envoyé par le PSU au TPP lors de la connexion chaîne de caractères Header non
PSU-Accept-Language Header "Accept-Language" envoyé par le PSU au TPP lors de la connexion chaîne de caractères Header non
PSU-Account-Consent-Responsibility

Cet header spécifie qui a été mandaté par le PSU pour garantir le respect des choix du PSU en matière d'accès individuel à chaque compte. L'AISP doit utiliser une des valeurs suivantes :

BY-AISP signifie que l'AISP a été délégué par le PSU pour gérer en détail l'accès au compte, dans ce cas l'ASPSP n'a pas à vérifier si une requête de l'AISP est autorisée.

BY-ASPSP signifie que l'ASPSP a pour obligation de garantir le respect des permissions accordées par le PSU à l'AISP concernant le détail de l'accès au compte ce qui implique de contrôler chaque requête venant de l'AISP.

chaîne de caractères Header oui
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 keyId="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 émise ce certificat HTTP400 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 à celle-ci chaîne de caractères Header

oui

 

 

Obtenir la liste des soldes get/accounts/{}/balances

 

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
accountResourceId Identification de la ressource utilisée comme critère principal dans la requête chaîne de caractères chemin oui
PSU-IP-Address Adresse IP utilisé par le PSU lors de la connexion au TPP chaîne de caractères Header non
PSU-IP-Port Port IP utilisé par le PSU lors de la connexion au TPP chaîne de caractères Header non
PSU-HTTP-Method Méthode http utilisée lors de la requête la plus pertinente faite par le PSU vers le TTP chaîne de caractères Header non
PSU-Date Timestamp utilisé lors de la requête la plus pertinente faite par le PSU vers le TTP chaîne de caractères Header non
PSU-GEO-Location Localisation géographique du PSU fournie par le terminal mobile du PSU au TPP si elle existe chaîne de caractères Header non
PSU-User-Agent Header "User-Agent" envoyé par le PSU lors de la connexion au TPP chaîne de caractères Header non
PSU-Referer Header "Referer" envoyée par le PSU lors de la connexion au TPP. 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 PSU au TPP lors de la connexion chaîne de caractères Header non
PSU-Accept-Charset Header "Accept-Charset" envoyé par le PSU au TPP lors de la connexion chaîne de caractères Header non
PSU-Accept-Encoding Header "Accept-Encoding" envoyé par le PSU au TPP lors de la connexion chaîne de caractères Header non
PSU-Accept-Language Header "Accept-Language" envoyé par le PSU au TPP lors de la connexion chaîne de caractères Header non
PSU-Account-Consent-Responsibility

Cet header spécifie qui a été mandaté par le PSU pour garantir le respect des choix du PSU en matière d'accès individuel à chaque compte. L'AISP doit utiliser une des valeurs suivantes :

BY-AISP signifie que l'AISP a été délégué par le PSU pour gérer en détail l'accès au compte, dans ce cas l'ASPSP n'a pas à vérifier si une requête de l'AISP est autorisée.

BY-ASPSP signifie que l'ASPSP a pour obligation de garantir le respect des permissions accordées par le PSU à l'AISP concernant le détail de l'accès au compte ce qui implique de contrôler chaque requête venant de l'AISP.

chaîne de caractères Header oui
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 keyId="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 émise ce certificat HTTP400 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 à celle-ci chaîne de caractères Header oui

 

Obtenir la liste des transactions get/accounts/{}/transactions

 

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
accountResourceId Identification de la ressource utilisée comme critère principal dans la requête 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
PSU-IP-Address Adresse IP utilisé par le PSU lors de la connexion au TPP chaîne de caractères Header non
PSU-IP-Port Port IP utilisé par le PSU lors de la connexion au TPP chaîne de caractères Header non
PSU-HTTP-Method Méthode http utilisée lors de la requête la plus pertinente faite par le PSU vers le TTP chaîne de caractères Header non
PSU-Date Timestamp utilisé lors de la requête la plus pertinente faite par le PSU vers le TTP chaîne de caractères Header non
PSU-GEO-Location Localisation géographique du PSU fournie par le terminal mobile du PSU au TPP si elle existe chaîne de caractères Header non
PSU-User-Agent Header "User-Agent" envoyé par le PSU lors de la connexion au TPP chaîne de caractères Header non
PSU-Referer Header "Referer" envoyée par le PSU lors de la connexion au TPP. 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 PSU au TPP lors de la connexion chaîne de caractères Header non
PSU-Accept-Charset Header "Accept-Charset" envoyé par le PSU au TPP lors de la connexion chaîne de caractères Header non
PSU-Accept-Encoding Header "Accept-Encoding" envoyé par le PSU au TPP lors de la connexion chaîne de caractères Header non
PSU-Accept-Language Header "Accept-Language" envoyé par le PSU au TPP lors de la connexion chaîne de caractères Header non
PSU-Account-Consent-Responsibility

Cet header spécifie qui a été mandaté par le PSU pour garantir le respect des choix du PSU en matière d'accès individuel à chaque compte. L'AISP doit utiliser une des valeurs suivantes :

BY-AISP signifie que l'AISP a été délégué par le PSU pour gérer en détail l'accès au compte, dans ce cas l'ASPSP n'a pas à vérifier si une requête de l'AISP est autorisée.

BY-ASPSP signifie que l'ASPSP a pour obligation de garantir le respect des permissions accordées par le PSU à l'AISP concernant le détail de l'accès au compte ce qui implique de contrôler chaque requête venant de l'AISP.

chaîne de caractères Header oui
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 keyId="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 émise ce certificat HTTP400 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 à celle-ci chaîne de caractères Header oui