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

image cinematique try it

L'utilisateur  fait appel à l'API via un formulaire (TRY-IT - sur la droite de l'écran) dans lequel il va sélectionner une application, un jeton d'authentification, un ressource Owner et saisir les paramètres définis dans la requête STET. 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.

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

 

image APP Authentication

Cet écran est accessible lorsque l'on édite l'application (TPP PISP notre exemple) 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.

Voici la description des différents paramètres pour initier une demande de paiement :

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-Device-ID UUID (Universally Unique Identifier) du périphérique utilisé par le PSU, si disponible chaîne de caractères Header non
Digest* donnée de la requête chaîne de caractères Body oui
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

 

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

 

image formulaire haut try it

 Pour les paramètres de type de données "body", il est possible de copier-coller un exemple dans le formulaire (à droite de l'écran) grâce à la petite loupe bleue présente dans la description des paramètres en entrée de la requête, en changeant juste les valeurs spécifiques :

image loupe pour coller exple

Cette loupe déploie une fenêtre avec le modèle du swagger ainsi qu'un exemple :

 

image test exemple

Il suffit alors de cliquer sur la flèche rose située en bas de cette fenêtre pour que les données de l'exemple alimentent la fenêtre du Try-It située sur la droite. A noter, l'exemple provient de STET, nous vous signalons qu'il comporte une erreur dans les codes schemeName utilisés. 

Suite à l'alimentation des paramètres obligatoires, la requête peut être soumise via la bouton "Executer". Le résultat est alors visible sous le bouton d'execution :

RESULTAT

Status code : 201 

 {
  "appliedAuthenticationApproach": "REDIRECT",
  "_links": {
    "consentApproval": {
      "href": "TPPPISPurlConsentApproval/psuId.html?resourceId=0000000180-1551358254000131359238543&nonce=Id-2ed9775ce61639e9a3c94ecc",
      "templated": null
    }
  }
}

 

Il est également possible de visualiser les données retournées dans le header en déroulant la fenêtre Entête :

image bandeau résultat try it

access-control-allow-origin: https://sandbox.api.89c3
access-control-expose-headers: x-correlationid
cache-control: no-cache, no-store, max-age=0, must-revalidate, public
connection: close
content-length: 218
content-type: application/hal+json;charset=utf-8
date: Thu, 13 March 2019 12:50:53 GMT
expires: 0
max-forwards: 5
pragma: no-cache
server: Apache
strict-transport-security: max-age=63072000; includeSubdomains;
via: 1.0 bilmwsg011.dom101.mapres ()
x-content-type-options: nosniff
x-correlationid: Id-2ed9775ce61639e9a3c94ecc 0
x-frame-options: SAMEORIGIN, DENY
x-nonce: Id-2ed9775ce61639e9a3c94ecc
x-xss-protection: 1; mode=block