Présentation PISTE pour les partenaires raccordés en API
PISTE Présentation générale Dans le cadre du programme Chorus Pro, l’AIFE a mis en œuvre une plateforme de gestion d’API. Cette plateforme, opérationnelle fin 2016, partagée par l’ensemble des administrations et les entreprises, propose aujourd’hui plus d’une centaine d’API, recevant plus de 15 millions d’appels par jour. Le projet PISTE, consistant à mutualiser cette plateforme de gestion des API, a été lancé dans le cadre du Plan de Transformation Numérique des Ministères Economiques et Financiers et s’inscrit dans le cadre du programme France Connect Plateforme, visant à bâtir le socle numérique de l’Etat-plateforme. Il consiste à renforcer le dispositif existant afin d’en faire une plateforme de gestion des API des Ministères Economiques et Financiers, permettant la publication de services ministériels. Une plateforme API mutualisée présente les avantages suivants : Point d’accès unifié : Point d’accès unique des partenaires pour la consommation de leurs API, quel que soit le fournisseur final du service ; Les évolutions de la plateforme ou des standards supportés bénéficient à l’ensemble des partenaires ; Gestion globale des accès par API ou par utilisateur : Gestion des habilitations ; Gestion des contrôles d’accès ; Gestion des domaines d’utilisation ; Uniformisation des accès. Centralisation du support de 1er niveau ; Supervision, indicateurs et rapports communs : Outils communs et mutualisés pour l’exploitation, le suivi, la supervision ou le support ; Possibilité de suivre des niveaux de service (SLA).
PISTE Les principales fonctionnalités Gérer le cycle de vie complet des API (Gestion de version, Dépréciation) Rationaliser l'administration des API d'une organisation en passant par : L’enregistrement et la publication d'API (dans un catalogue) ; L’enregistrement d'organisations tierces (Applications) et des développeurs. Offrir une interface web publique (portail de développeur) permettant : Aux développeurs de s’enregistrer et de générer des identifiants pour leurs applications ; De fournir des outils pour explorer et tester les API ; Assurer la sécurité et la protection des API avec les normes de sécurité standards et communes Auditer et monitorer l’activité des API. <PISTE>
Appels API Architecture de la plateforme actuelle API Manager SI partenaire Chorus Pro Requête HTTPS avec certificat, login/mot de passe du compte technique et le corps JSON 1 Réponse à la requête au format JSON 3 SI tiers Back end Traitement de la requête 2
PISTE Présentation de la nouvelle architecture Back end SI partenaire Chorus Pro 1 2 SI tiers API Manager Demande d’un jeton d’accès avec identifiant et mot de passe partenaire 2 Envoi du jeton 3 4 Transmission de la requête Requête HTTPS avec jeton, login/mot de passe du compte technique et le corps JSON Traitement et réponse 5 Réponse à la requête au format JSON 6 PISTE Le jeton a une durée de vie d’une heure, il est utilisable pour faire tous les appels. Lorsque le délai est dépassé, il faut refaire une demande de jeton.
PISTE Migration pour les partenaires déjà raccordés Principes : Il est nécessaire de migrer les partenaires raccordés vers la nouvelle plateforme PISTE. Cette migration sera transparente pour ces partenaires. Tous les raccordements avec certificat vont migrer dans PISTE. Les appels actuels avec les URL et les certificats fonctionneront toujours. Le raccordement sera toujours accessible par le portail via l’espace « raccordement EDI/API » Le renouvellement du certificat sera possible pour les partenaires qui ne sont pas encore prêt à faire les appels avec le protocole oAuth2. Les API non utilisées actuellement ne seront pas migrées (gestion de structure, gestion utilisateurs) Certaines API en doublons seront dépréciées Il est prévu avec des pilotes de réaliser une phase de validation de la migration. Les partenaires intéressés peuvent faire leur demande à l’adresse suivante : api-choruspro.aife@finances.gouv.fr
PISTE Migration pour les partenaires déjà raccordés Les étapes : Identification des pilotes Environnement de qualification : Phase pilote de migration des raccordements. Tests du bon fonctionnement et validation par les pilotes identifiés. Suivi opérationnel dédié avec les pilotes Environnement de qualification : Généralisation de la migration des raccordements. Surveillance du bon fonctionnement. Environnement de production : Phase pilote de migration des raccordements. Environnement de production : Généralisation de la migration des raccordements.
PISTE Partenaires déjà raccordés Bascule vers le protocole oAuth2 Les étapes pour se raccorder à Chorus Pro en oAuth2 : S’enregistrer sur PISTE Récupération pour les tests à effectuer en qualification De l’identifiant PISTE à indiquer lors du raccordement dans Chorus Pro Qualification Des identifiants oAuth2 à utiliser lors des appels API en qualification Création d’une application pour la production qui génèrera : Un identifiant à communiquer lors du raccordement dans Chorus Pro Production Les identifiants oAuth2 à utiliser lors les appels API en production Mise en place de l’évolution des appels dans vos environnements Valider votre solution en qualification : Dans Chorus PRO : Créer le raccordement API oAuth2 Valider le bon fonctionnement des appels API Bascule des appels sur le protocole oAuth2 Valider votre solution en production : Il est possible de faire en parallèle vos appels API avec l’ancien et le nouveau protocole. Une documentation d’aide à la mise en œuvre vers le protocole oAuth2 est disponible dans le portail PISTE
PISTE Nouveaux partenaires Tous les nouveaux partenaires doivent se raccorder à Chorus Pro avec le protocole oAuth2. Le processus de raccordement se fera en deux étapes : sur PISTE puis sur Chorus Pro Création de compte et application sur PISTE Enregistrement sur PISTE et découverte du catalogue des API Application pour les tests en qualification créée par défaut avec : Un identifiant à communiquer lors du raccordement dans Chorus Pro Qualification Les identifiants oAuth2 sont générés et disponibles Création d’une application pour la production avec génération : de l’identifiant de l’application à communiquer lors du raccordement dans Chorus Pro Production des identifiants oAuth2 sont générés et disponibles Création du raccordement dans Chorus Pro en qualification Enregistrement sur le portail de Qualification Création du matelas de données Création du raccordement oAuth2 avec communication de l’identifiant généré par PISTE Création du compte technique Validation du bon fonctionnement des appels API Création du raccordement dans Chorus Pro en production S’enregistrer et créer sa structure Création du raccordement oAuth2 dans Chorus Pro avec communication de l’identifiant généré par PISTE Pour les partenaires raccordés en direct : Création du compte technique Pour les concentrateurs : collecte des comptes techniques des clients
Application production PISTE Schéma d’appels API en Qualification et Production Qualification SI partenaire Chorus Pro 1 2 Application test API Manager Appel API oAuth2 en qualification avec les identifiants oAuth2 de qualification et compte technique 2 Transmission de la requête Traitement et réponse 4 3 Réponse à la requête au format JSON Application production 1 2 Transmission de la requête Production Appel API en production avec les identifiants oAuth2 de production et compte technique Traitement et réponse 3 Réponse à la requête au format JSON 4 PISTE
PISTE Portail développeur et support https://developer.aife.economie.gouv.fr Guide utilisateur : https://developer.aife.economie.gouv.fr/help-center/documentation Formulaire de contact pour toute question ou sollicitation Support PISTE Rubrique AIDE > CONTACT