Ce guide précise les étapes de création d’une application en PRODUCTION sur PISTE.

En prérequis, vous avez créé un compte sur PISTE.

 

 

1.1          Se connecter à PISTE

 

• Connectez-vous à PISTE  en cliquant sur « Se connecter »
• Identifiez-vous avec l’identifiant et le mot de passe créés précédemment.

 

1.2          Créer une application

 

• Accédez au menu « Applications » du bandeau des menus
• Cliquez ensuite sur « Créer une application »

Cliquez ensuite sur « Créer une application » :

• Dans la page qui s’ouvre, renseignez les informations générales de votre application. Le nom de votre application doit être unique et ne peut pas contenir de caractères spéciaux autres que « - » ou « _ ».
• Dans le champ « Organisation », indiquez « Service-PPF ».

 

L’utilisation de certaines API nécessite de prendre connaissance puis de valider les CGU particulières associées. Vous pouvez les consulter et les valider dans la rubrique CONSENTEMENT CGU API.

Une fois les CGU des API validées, vous serez en mesure de sélectionner les API que vous souhaitez utiliser dans votre application puis cliquez sur « Sauvegarder l’application » pour valider votre saisie.

Si les API sélectionnées dans votre application sont soumises à la validation de l’approbateur des API, se référer au Guide Utilisateur PISTE.

 

 

Pour accéder aux informations concernant une application ou pour la modifier, cliquer sur son nom ou sur son icône dans la liste de vos applications. Les deux onglets suivants sont alors accessibles :

• L’onglet « Détails » depuis lequel vous accédez aux informations générales ;
• L’onglet « Usage » dans lequel vous pouvez consulter les statistiques d’utilisation de votre application.

 

Pour modifier les informations d’authentification de votre application ou lui ajouter des API, cliquez sur le bouton « Modifier l’application » :

 

NB : Veuillez noter qu’hormis les modifications des informations d’authentification et l’ajout ou le retrait d’API, il n’est désormais plus possible de modifier le nom de l’application.

Enfin comme pour les applications SANDBOX, vous pouvez sélectionner et/ou demander l’accès aux API dont vous avez la visibilité dans le tableau en bas de page.

 

 

Depuis l’onglet « Authentification », vous constaterez que des informations d’authentification de type API Key/Oauth ont été générées automatiquement suite à la création de votre application.

Néanmoins, il vous est possible de générer de nouvelles informations d’authentification de type API Key, identification Oauth, identification externe ou scopes.

 

NB : Les « identifiants externes » n’étant pas utilisés à ce jour sur PISTE, il n’existe pas de paragraphe dédié dans ce guide.

 

Cliquez sur le bouton « Générer » pour lancer la génération d’une API Key :

 

 

Puis retournez dans l’onglet « Détails » et cliquez sur le bouton « Appliquer les modifications » pour sauvegarder ces informations. Votre application est désormais opérationnelle.

 

Cliquez sur le bouton « Générer » pour lancer la génération d’un Identifiant Oauth :

La fenêtre suivante s’affiche, renseignez l’ensemble des informations nécessaires puis cliquez sur « Générer un client » pour obtenir votre identifiant.

5.1 Choix du type d’application Oauth

 

Oauth définit deux types de clients, basés sur leur capacité à s’authentifier en toute sécurité sur le serveur d’autorisation. En fonction du cas de figure dans lequel vous vous trouvez, il vous est demandé de choisir le type de client confidentiel ou public :

Confidentiel : il s’agit d’un client qui a la capacité de maintenir la confidentialité de ses informations d’identification ou de sécuriser l’authentification client à l’aide d’autres moyens.

Public : Il s’agit d’un client qui a les aptitudes inverses d’un client confidentiel.

 

5.2 URL de rappel

 

Les URLs de rappel sont utilisées afin de renseigner les URLs du client vers lesquelles les informations du serveur d’autorisation (contenant le code d’autorisation et le token d’accès) seront transmises. Néanmoins, dans le cas où il n’y a pas de nécessité d’avoir des redirections, cette case peut rester vide notamment pour le flux Client Credentials.

 

5.3 Certificat X.509

 

Comme indiqué, ce champ permet de spécifier le certificat qui est utilisé pour vérifier la signature du jeton soumis par PISTE. Si ce besoin n’est pas spécifié, il n’est pas nécessaire de remplir ce champ.

En cas de difficulté, vous pouvez vous adresser au support au travers d’une sollicitation.

 

 

Un Client ID peut être modifié, désactivé, supprimé ou consulté en sélectionnant l’une des « Actions » disponibles.

 

 

La régénération du secret permet d’empêcher tout accès non autorisé. Elle est accessible depuis l’action « Modifier » puis le bouton « Régénérer ». Une fois cette opération réalisée, l’ancien secret devient invalide. Utilisez le bouton Secret Client pour demander de nouveaux jetons d’accès.

 

 

NB : Pour des raisons de sécurité, il est vivement recommandé de régénérer un client secret régulièrement. Nous préconisons une modification tous les 3 mois.

 

L’utilisation de votre application est soumise à un quota limité par défaut à 20 requêtes par seconde. Si vous dépassez ce seuil, une erreur http 429 Too Many requests/Trop de requêtes sera renvoyée. Ce quota peut être modifié :

• à l’initiative des administrateurs PISTE ;
• à l’initiative des fournisseurs d’API afin de pouvoir limiter les accès ;
• à l’initiative des applications consommatrices au travers d’une sollicitation. Cette demande sera à justifier et soumise à approbation des administrateurs PISTE et fournisseurs d’API.

 

Ce nouveau quota défini prévaudra sur celui par défaut.