Seres Manuel Spécifications Web-Services SOAP (FR)

Document Йvolution du document Licence Ce document n'est pas libre de droits. Ce manuel est publiй sous la licence Creative Commons avec les particularitйs “Paternitй – Partage а l'identique” (йgalement connue sous l'acronyme CC BY-SA). Dйtails de cette licence :

http://creativecommons.org/licenses/by-sa/2.0/fr/ Manuel de spйcifications web-services SOAP i-Parapheur - Version 4.x page 2 / 25 Auteur Stephane VAST Date de diffusion 02/02/2021 Chef de projet Stephane VAST N° de version 4.x Version Auteur Nature des changements Date 1.0 Stephane VAST Création du document 30/01/2019 1.1 Stephane VAST Précisions sur cas PESv2 24/09/2019 1.2 Stephane VAST Simplification pour connexion HTTPS 18/05/2020 1.3 Stephane VAST Précision sur URLs à utiliser 02/02/2021

Стр. 2

Table des matiиres

Table des matiиres 1 ЙLЙMENTS FONCTIONNELS 5 1.1 Objectifs 1.2 Rappels sur l'application i-Parapheur 5 5 1.2.1 Gйnйralitйs 1.2.2 Philosophie du produit 1.3 Modalitйs de dialogue 5 5 7 1.3.1 Contrat WEB-SERVICES SOAP 1.3.2 Modиle d'implйmentation dйprйciй 1.4 Architecture logicielle serveur 1.5 Mode d'accиs (sйcuritй et authentification) 7 7 7 8 1.5.1 Ancien mode: authentification forte MCA, dйprйciйe.

1.6 Gestion des йvolutions 1.7 Cas de flux mйtier format XML 1.8 Identifiant unique de transaction 1.9 Diffйrents йtats de dossier 2 FONCTIONNALITЙS PARTICULIИRES OFFERTES 8 9 9 10 10 12 2.1 Droit de remord 2.2 Cas de rejet de dossier 2.3 Archivage (DEPRECIE) 2.4 Historisation des actions 2.5 Envoi а un TdT 3 CINЙMATIQUES 12 12 12 12 12 13 3.1 Scйnario-type de crйation de dossier 4 LISTE DES WEB-SERVICES 13 14 4.1 echo 14 4.1.1 Donnйes en entrйe 4.1.2 Donnйes en sortie 4.2 GetListeTypes – Interrogation des types techniques disponibles 14 14 14 4.2.1 Donnйes en entrйe 4.2.2 Donnйes en sortie 4.3 GetListeSousTypes – Interrogation des sous-types disponibles 14 14 14 4.3.1 Donnйes en entrйe 4.3.2 Donnйes en sortie 4.4 GetCircuit – Interrogation du circuit relatif а un type/sous-type 14 14 14 4.4.1 Donnйes en entrйe 4.4.2 Donnйes en sortie 4.5 GetListeMetaDonnees – Interrogation des mйta-donnйes disponibles 14 14 14 4.5.1 Donnйes en entrйe 4.5.2 Donnйes en sortie 4.6 Interrogations pour un compte utilisateur tiers 15 15 15 4.6.1 IsUtilisateurExiste 4.6.2 GetListeTypesPourUtilisateur 4.6.3 GetCircuitPourUtilisateur 4.7 GetMetaDonneesRequisesPourTypeSoustype 15 15 15 15 4.7.1 Donnйes en entrйe 4.7.2 Donnйes en sortie 4.8 CreerDossier – Crйation de dossier 15 15 16 4.8.1 Donnйes en entrйe 4.8.2 Donnйes en sortie 4.9 GetHistoDossier – Interrogation d'histogramme de dossier 16 16 16 4.9.1 Donnйes en entrйe 4.10 Donnйes en sortie 4.11 EffacerDossierRejete – purge de dossier rejetй 17 17 17 4.11.1 Donnйes en entrйe 4.11.2 Donnйes en sortie 4.12 RechercherDossiers – Recherche de dossier 17 17 17 4.12.1 Donnйes en entrйe 4.12.2 Donnйes en sortie 4.13 EnvoyerDossierTdT – Envoi d'un dossier au TdT 17 17 17 4.13.1 Donnйes en entrйe 4.13.2 Donnйes en sortie 4.14 GetStatutTdT – Interrogation de statut TdT d'un dossier 18 18 18 4.14.1 Donnйes en entrйe 4.14.2 Donnйes en sortie 4.15 GetClassificationActesTdt – Interrogation de classification ACTES 18 18 18 4.15.1 Donnйes en entrйe 4.15.2 Donnйes en sortie 4.16 ForcerEtape – Forcer le passage d'une йtape 18 18 18 4.16.1 Donnйes en entrйe 18 Manuel de spйcifications web-services SOAP i-Parapheur - Version 4.x page 3 / 25

Стр. 3

Table des matiиres

4.16.2 Donnйes en sortie 4.17 GetDossier – Rйcupйration du dossier en fin de circuit 18 19 4.17.1 Donnйes en entrйe 4.17.2 Donnйes en sortie 4.18 ExercerDroitRemordDossier – Exercice du droit de remord 19 19 19 4.18.1 Donnйes en entrйe 4.18.2 Donnйes en sortie 4.18.3 ArchiverDossier – Purge de i-Parapheur 4.18.4 Donnйes en entrйe 4.18.5 Donnйes en sortie 4.19 EnvoyerDossierMailSecurise – Envoi de dossier par SІlow Mail Sйcurisй 19 19 19 20 20 20 4.19.1 Donnйes en entrйe 4.19.2 Donnйes en sortie 5 A PROPOS D'ADMINISTRATION ET PARAMЙTRAGE 20 20 21 5.1 Types 5.2 Sous-types 6 ANNEXES – POINTS DIVERS 21 21 22 6.1 Statuts de dossiers possibles 6.2 Qualification – prototypage avec SoapUI 6.3 Prй-requis techniques а i-Parapheur 7 GLOSSAIRE 22 22 24 25 Manuel de spйcifications web-services SOAP i-Parapheur - Version 4.x page 4 / 25

Стр. 4

1.2.2 Philosophie du produit

1. ЙLЙMENTS FONCTIONNELS 1.1. Objectifs Ce document prйsente la librairie de Web-Services mйtier exposйe par i-Parapheur, а l'usage des applications tierces. La 1иre version de ces spйcifications a йtй implйmentйe dans i-Parapheur v2.1.5, la prйsente йdition de ce document est labellisйe v4.x , et s'applique aux versions 4.5.0 de i-Parapheur et supйrieur. 1.2. Rappels sur l'application i-Parapheur 1.2.1. Gйnйralitйs Le dйveloppement de l’administration йlectronique et de la dйmatйrialisation placent la modйlisation de procйdures de gestion et la signature йlectronique au cœur des processus de gestion des collectivitйs publiques.

L’application i-Parapheur a йtй conзue pour rйpondre а ces nouveaux besoins, en permettant la circulation, la validation, la signature йlectronique de documents et de flux mйtiers multiples crййs dans le cadre de l’activitй de gestion des administrations, des collectivitйs territoriales ou autres organismes. En tant que dispositif central (transverse) de systиme d’information, le i-Parapheur a йtй dotй d’outils de communication permettant son couplage avec les logiciels mйtiers comme avec les plate-formes de tйlй-procйdures les plus couramment exploitйes. 1.2.2. Philosophie du produit Le parapheur йlectronique i-Parapheur est basй sur des « technologies Web ».

Il permet la circulation multi-documents (piиce principale, accompagnйe de PJ), regroupйs au sein d'un « dossier », en suivant les йtapes d'un circuit de validation. Chaque acteur successif (selon l'action demandйe) « vise », « signe », ou « scelle » le(s) document(s) constitutif(s) d'un dossier; et enfin le dernier bureau gиre l'extraction (pour « archive ») du dossier. Le circuit de validation est dйfini а la crйation du dossier dans l'application. Dans ce contexte, on considйrera l'application mйtier comme un « acteur » particulier.

А ce titre, а l’instar d’un utilisateur humain, cet automate va piloter le i-Parapheur via une bibliothиque de web-services ; le principe de cette bibliothиque de services web est d'offrir а l’application tierce les capacitйs d'un йmetteur de dossier, notamment :

crйer et soumettre pour validation des dossiers dans i-Parapheur, aprиs sйlection de la typologie adйquate, capacitй de « suivre » l'йtat d'avancement des dossiers soumis en validation (outils de recherche) rйcupйrer les dossiers en fin de circuit, avec histogramme et mйta-donnйes purger les dossiers aprиs rйcupйration, sur succиs ou йchec de la validation Ainsi, l'application tierce est un utilisateur virtuel (non-humain) de i-Parapheur. Elle sera donc dotйe d'un « bureau » et disposera d'un compte utilisateur (identifiant et mot de passe) dйdiйs. A noter que toutes les interactions entre applicatif mйtier et i-Parapheur se font а l'initiative de l'application mйtier :

i-Parapheur agit en plate-forme serveur. L'illustration ci-aprиs prйsente un cas d'utilisation possible de cinйmatique entre une plate-forme applicative et i-Parapheur : Manuel de spйcifications web-services SOAP i-Parapheur - Version 4.x page 5 / 25

Стр. 5