Console Try-it

➤ Principe

En vous connectant sur le portail 89C3 API, vous pouvez :

  • faire appel à l'API "Information sur compte" via un formulaire dans lequel vous sélectionnez votre application et le jeton d'authentification/d'accès
  • puis vous saisissez les paramètres de la méthode que vous souhaitez tester (soit header, soit body) dont ceux mentionnés par une étoile sont 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 à vue et des cartes à débit différé adossées à ces comptes à vue. Cela vous permet de récupérer le "ressourceId" nécessaire pour passer ces méthodes pour le compte à vue ou la carte à débit différé. 

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

L'utilisateur peut choisir un profil spécifique de client pour son test de façon à mieux appréhender les résultats obtenus. 

En cas de nécessité, une pagination des résultats sera faite pour faciliter la lisibilité et des liens de navigation entre les différentes pages de résultats seront présents (voir les exemples présents dans les cas d'usage "Obtenir la liste des comptes" et "Obtenir les transactions").

 

➤ Création d’une application de test

La création d’une application de test qui utilise l’API stetpsd2v142 sur le portail 89C3 API est un prérequis à l’utilisation de la console "Try-It" pour tester des appels à notre API Information sur compte pour la version v1.4.2 de la norme STET

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.

Il faut avoir renseigné les identifiants OAuth avec :

  • Type d’application : Public
  • "*" dans le champ "Origines Javascript"
  • Une URL syntaxiquement valide dans le champ "Rediriger les URL". Par exemple : "https://monappli.com"
  • Ne rien mettre dans le champ Certificat X.509 (juste un caractère "1" par exemple)

L’onglet "clients de test" permet de voir les identifiants des personas qui seront sélectionnables dans la console Try-It.

 

➤ Aperçu de l'écran permettant de récupérer le jeton Oauth2

 Try it2

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 du Try-It

La console Try-It est disponible en haut à droite des pages présentant les opérations disponibles sur une API. Par exemple, pour l’API Consultation de compte STET v1.4.2, si l’on sélectionne une opération dans le menu sous le bloc STETPSD2V142, la description de l’opération (issu du fichier swagger sous-jacent) est présentée et on peut accéder à la console Try-It pour tester cette opération.

Form Execution Try it AISP FR

 

Cliquer sur le bouton Exécuter.

!--

  

➤ 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.

Note : en fait, dans la console Try-It, le renseignement de ce paramètre en header est caché et implicite. La valeur envoyée dépend du choix de la combobox "Client OAuth"
Chaîne de caractères Header Oui
PSU-IP-Address

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

*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 du terminal utilisé par le client connecté sur votre APP 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 APP Chaîne de caractères Header Non
PSU-Referer Header "Referer" envoyée par le terminal du client connecté à votre APP. 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 APP. Chaîne de caractères Header Non
PSU-Accept-Charset Header "Accept-Charset" envoyé par le terminal du client connecté à votre APP. Chaîne de caractères Header Non
PSU-Accept-Encoding Header "Accept-Encoding" envoyé par le terminal du client connecté à votre APP. Chaîne de caractères Header Non
PSU-Accept-Language Header "Accept-Language" envoyé par le terminal du client connecté à votre APP. Chaîne de caractères Header Non
PSU-Device-ID UUID (Identifiant Unique Universel) pour un périphérique utilisé par le client, s'il est disponible. L'UUID identifie un périphérique ou l'installation d'une application dépendante d'un périphérique. Dans le cas d'une identification d'installation cet ID nécessite d'être persistant jusqu'au retrait du périphérique. 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 é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

 

Paramètre propre à la méthode "Obtenir les soldes d'un compte à vue ou les encours des cartes à débit différé adossées à ce dernier"  - 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":"" } ;
  • soit pour une carte à débit différé tel que "accountId": {"other": {"schemeName": "CPAN"}})
Chaîne de caractères Chemin Oui

 

Paramètres propres à la méthode "Obtenir les transactions d'un compte à vue ou les facturettes des cartes à débit différé adossées à ce dernier" - 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":"" } ;
  • soit pour une carte à débit différé tel que "accountId": {"other": {"schemeName": "CPAN"}})
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
-->