Description des scopes des interfaces des applications de l'écosystème ISV

1. Aperçu

Ce document vise à fournir aux développeurs partenaires de l'écosystème une explication sur les Scopes (domaines d'autorisation) du système d'autorisation des applications eSignGlobal. Lors de l'intégration de l'autorisation des applications, les développeurs doivent demander le Scope correspondant en fonction des besoins fonctionnels réels de leur activité. Chaque Scope contient la liste des OpenAPI autorisées à être appelées sous ce domaine d'autorisation. La plateforme contrôlera strictement les permissions des applications pour opérer sur les ressources pertinentes en fonction des Scopes autorisés.

Interface d'authentification de base

Avant que les applications de l'écosystème n'appellent officiellement les interfaces, elles doivent d'abord obtenir les jetons d'appel via le point de terminaison d'autorisation :

Nom de l'interface	Chemin de l'interface	Description de l'interface
Obtenir un AccessToken	`POST /esignglobal/v1/oauth2/accessToken`	Via l'appid et l'appsecret pour obtenir le access_token d'authentification, utilisé pour effectuer des requêtes auprès de l'API eSignGlobal au nom d'un utilisateur spécifique. La durée de validité du Token est de 24 heures.

Les domaines d'autorisation Scope actuellement ouverts dans l'écosystème eSignGlobal comprennent principalement :

signature: Service principal de signature électronique
stamp: Service de gestion des cachets
comparisons: Service de comparaison de contrats

2. Détails du Scope et liste des interfaces

2.1 Scope: `signature` (Service de signature électronique)

Ce Scope est le périmètre d'autorisation le plus fondamental et le plus courant, intégrant les interfaces principales de bout en bout pour la signature électronique. Une fois ce Scope autorisé, l'application peut gérer et orchestrer les flux de travail liés aux modèles, aux documents à signer (y compris les pièces jointes), aux parties prenantes et aux enveloppes.

Module 1 : Service de modèles

Nom de l'interface	Description de l'interface
Obtenir les détails des contrôles de modèle du signataire	Obtenir les informations sur les contrôles de modèle du signataire spécifié ainsi que leurs configurations d'attributs associées
Obtenir les détails du modèle	Obtenir les informations complètes d'un modèle spécifique, incluant les détails des champs et de la structure du fichier
Remplir un modèle pour générer un fichier	Remplir les données métier selon le modèle fourni et générer automatiquement un fichier au format PDF
Récupérer la liste des modèles	Rechercher par pagination ou selon des critères de filtrage spécifiques la liste des modèles disponibles pour le compte actuel
Obtenir les détails de la tâche de fusion de fichiers	Interroger le résultat d'exécution final d'une tâche de génération de fichier par modèle à l'aide de l'ID de tâche asynchrone

Module 2 : Gestion des fichiers

Nom de l'interface	Description de l'interface
Téléverser un fichier	Téléverser les fichiers locaux spécifiés ou les fichiers du flux métier sur la plateforme, en vue d'une signature ultérieure
Obtenir les coordonnées en fonction des mots-clés	Effectuer une recherche textuelle dans les documents téléversés et retourner les informations de coordonnées de position des mots-clés correspondants
Télécharger un fichier	Télécharger des documents signés spécifiques, des fichiers sources ou d'autres fichiers annexes liés au métier
Ajouter un document à signer	Lier les fichiers précédemment téléversés avec succès à une enveloppe de signature ou un processus spécifique
Supprimer un document à signer	Retirer du flux de l'enveloppe de signature les fichiers téléversés par erreur ou temporairement non nécessaires à la signature
Ajouter une pièce jointe	Ajouter des pièces jointes explicatives supplémentaires au processus d'enveloppe ou de signature
Supprimer la pièce jointe	Supprimer les documents de pièces jointes spécifiés du processus d'enveloppe ou de signature

Module 3 : Gestion des participants

Nom de l'interface	Description de l'interface
Ajouter un signataire	Ajouter un participant à la signature devant effectuer la signature dans un processus d'enveloppe spécifique
Supprimer le signataire	Supprimer un signataire désactivé d'un processus d'enveloppe spécifique
Ajouter un destinataire en copie	Ajouter un rôle de copie, recevant uniquement les notifications d'avancement et pouvant consulter le document final signé
Supprimer le destinataire en copie	Supprimer le rôle de copie spécifié

Module 4 : Gestion des enveloppes

Nom de l'interface	Description de l'interface
Lancement rapide d'enveloppe	Si la plateforme connectée utilise cette interface pour créer une enveloppe et que le système gère automatiquement la fin du processus après signature, il n'est pas nécessaire d'appeler manuellement « Terminer l'enveloppe ».
Créer une enveloppe	Permet de créer une enveloppe à l'état brouillon, avec prise en charge de la configuration du sujet de signature, des paramètres des signataires, etc.
Activer l'enveloppe	Une fois tous les documents à signer et les signataires vérifiés, envoie officiellement la tâche de signature au flux aval.
Terminer l'enveloppe	Fin manuelle de l'enveloppe. Avant la fin de l'enveloppe, tous les signataires doivent avoir signé. Une fois le processus terminé, les ressources ne peuvent plus être modifiées.
Obtenir l'adresse de signature	Obtenir le lien court dédié ou l'URL de la page de signature directement chargeable pour un signataire spécifique.
Consulter les détails de l'enveloppe	Obtenir les informations générales de l'enveloppe, les fichiers associés, les participants ainsi que l'état actuel du flux de travail.
Annuler l'enveloppe	Retrait actif par l'initiateur d'une enveloppe de signature non entièrement finalisée
Relance d'enveloppe	Lorsque l'enveloppe n'est pas encore entièrement signée, il est possible d'envoyer un rappel aux signataires concernés qui n'ont pas encore signé, avec un intervalle de relance de 30 minutes.
Récupérer l'URL de la page de prévisualisation de signature	Une fois l'enveloppe ouverte, cette interface permet de récupérer l'URL de la page de prévisualisation de signature. Elle est principalement utilisée au sein de la plateforme intégrée pour permettre aux non-participants de consulter les documents et l'avancement de la signature.
Créer une vue d'envoi d'enveloppe	Créer une vue de l'expéditeur d'enveloppe à partir de l'ID de l'enveloppe. Pour les flux de signature initiés dans cette vue, les informations de l'initiateur seront remplies avec les données utilisateur extraites du jeton d'accès (Access Token) OAuth.

2.2 Scope: `stamp` (Service de gestion des cachets)

Ce Scope est spécifiquement dédié à l'autorisation de gestion des cachets d'entreprise ou des signatures personnelles. Il convient aux écosystèmes tiers qui n'ont besoin que de maintenir une base de données centralisée de cachets d'entreprise (ajout, suppression, modification, consultation) sans intervenir directement dans le processus d'initiation de la signature.

Nom de l'interface	Description de l'interface
Rechercher la liste des cachets	Utiliser un AppID disposant des autorisations de requête correspondantes pour obtenir la liste des ressources de cachets.
Créer un cachet	Utiliser un AppID autorisé pour créer un cachet à partir de la chaîne codée en Base64 de l'image téléchargée (format PNG pris en charge, taille comprise entre 18 mm et 100 mm).
Modifier le cachet	Modifier les informations telles que le nom et l'image du cachet créé.
Supprimer le cachet	Supprimer définitivement les ressources de cachet spécifiées qui ne sont plus liées à des activités métier.

2.3 Scope: `comparisons` (Service de comparaison de contrats)

Ce Scope est dédié au domaine fonctionnel juridique des contrats intelligents. Il permet aux applications partenaires de l'écosystème d'appeler de manière flexible les capacités de comparaison de textes et de versions lors de leurs propres processus de révision de contrats et d'évaluation juridique, afin de contrôler rapidement les différences avant et après la révision des contrats.

Nom de l'interface	Description de l'interface
Obtenir la page des résultats de comparaison de contrats	Obtenir l'adresse de la page de visualisation affichant les résultats des différences de comparaison
Consulter les détails de la comparaison de contrats	Obtenir le résultat de la comparaison de contrat via l'ID métier de comparaison de contrats, incluant le nombre de différences (ajouts, suppressions, modifications) ainsi que le contenu détaillé des différences comparées (localisation des détails).