Signature électronique connective
Connective eSignatures est une solution de signature numérique renommée offrant une grande quantité de méthodes de signature et de conformité aux réglementations nationales les plus strictes (inter). eSignatures vous permet de transformer n’importe quel processus papier en flux numérique de bout en bout avec une expérience utilisateur inégalée. Simplifiez le processus de signature exactement comme vous le souhaitez et envoyez, signez et suivez tous les types de documents directement à partir de vos applications métier préférées. Rejoignez plus de 500 clients satisfaits.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Contact | |
|---|---|
| Nom | Prise en charge connective |
| URL | https://connective.eu/contact-support/ |
| Messagerie électronique | service@connective.eu |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Connectif |
| Site internet | https://www.connective.eu |
| Politique de confidentialité | https://connective.eu/privacy-policy/ |
| Catégories | Opérations informatiques ; Productivité |
Connective, spécialiste des signatures numériques, des services d’identité et de la génération de documents intelligents, a rendu le connecteur connectif eSignatures pour Power Automate disponible pour l’utilisation. Le connecteur permet aux entreprises de transférer des documents qui nécessitent une signature numérique directement à partir de leurs applications Microsoft 365 favorites , de Microsoft Teams à Word, SharePoint, Dynamics, OneDrive et bien d’autres.
Comment commencer à utiliser le connecteur
Pour commencer à utiliser le connecteur, contactez votre responsable de relation à Connective ou accédez à notre page de contact sur notre site web pour recevoir les informations d’identification.
Cette page détaille davantage les différentes actions disponibles, ainsi que fournir des informations sur les différentes façons dont ces actions peuvent être implémentées.
N’hésitez pas à consulter notre site web de documentation pour plus d’informations ou contacter l’équipe de support via le formulaire de contact ou la boîte aux lettres du support technique : service@connective.eu
Un glossaire est disponible pour expliquer les différents termes utilisés dans cette documentation
Actions
Le connecteur Connective eSignatures est basé sur l’API v3 des eSignatures. L’API eSignatures est une API REST qui permet aux applications externes d’intégrer et d’utiliser les fonctionnalités répertoriées dans ce document pour créer et gérer des flux de signature.
Les actions disponibles peuvent être regroupées en différents groupes
| Groupe d’actions | Actions disponibles |
|---|---|
| Chargement de documents | Créer un package |
| Ajouter un document au package | |
| Obtenir les emplacements de signature | |
| Définir les informations de processus | |
| Définir l’état du package | |
| Créer un package instantané | |
| Récupération de l’état d’un document | Obtenir l’état du package |
| Obtenir la liste des packages | |
| Diverses actions | Ignorer les signataires |
| Télécharger le package | |
| Extension d’expiration du package | |
| Envoyer un rappel de package | |
| Supprimer le package | |
| Récupération de la preuve d’audit | Récupérer les preuves d’audit de package |
| Récupérer les preuves d’audit de document | |
| Récupérer les preuves d’audit de package avec l’ID de corrélation | |
| Récupérer les preuves d’audit de document avec l’ID de corrélation | |
| Ajouter une preuve à partir d’une source externe |
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| URL de l’environnement Connective eSignatures | ficelle | URL de votre environnement Connective eSignatures, par exemple. esignatures.connective.eu | Vrai |
| Nom d’utilisateur de l’API | securestring | Nom d’utilisateur de l’API pour accéder à l’API | Vrai |
| Mot de passe de l’API | securestring | Mot de passe de l’API pour accéder à l’API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Ajouter un document au package |
Cet appel ajoute un document à un package existant. |
| Ajouter une preuve à partir d’une source externe |
Cet appel permet aux utilisateurs d’API d’ajouter des preuves supplémentaires d’une source externe à un emplacement sur un document. |
| Créer un package |
Cet appel crée un package vide, ce qui permet aux documents d’être ajoutés à celui-ci |
| Créer un package instantané |
Cet appel crée un package avec un document unique dans celui-ci et le prépare instantanément pour la signature |
| Définir les informations de processus |
Cette méthode de service web met à jour les personnes impliquées dans le processus (parties prenantes) et leur attribue des étapes qui doivent être prises. |
| Définir l’état du package |
Au moyen de l’appel Définir l’état du package, vous pouvez modifier l’état d’un package. |
| Envoyer des rappels de package |
La stratégie d’entreprise peut exiger qu’un document soit géré dans un intervalle de temps donné. Le déclenchement de l’appel « envoyer des rappels » recherche tout le monde qui n’a pas signé et envoie une notification supplémentaire en tant que rappel. |
| Horodatage d’expiration |
Un package peut avoir l’état Expiré lorsqu’un package a passé une valeur pour le paramètre ExpiryTimestamp dans l’appel Create Package. Un tel package ne peut plus être signé. |
| Ignorer les signataires |
Cet appel ignore tous les signataires qui n’ont pas encore signé et définit leur état sur « Ignoré », ce qui entraîne la marque « Terminé » dans le package complet. |
| Liste des packages |
Obtenir la liste des packages avec leur état actuel |
| Obtenir les emplacements de signature |
Cet appel fournit une vue d’ensemble de tous les emplacements de signature à l’intérieur des documents au sein d’un package. |
| Obtenir l’état du package |
Récupère l’état actuel du package et de ses documents. |
| Preuve d’audit du package avec l’ID de document |
Le xml de preuve d’audit d’un package peut être récupéré lorsque le package est entièrement signé. La même chose s’applique à un document : il fonctionne uniquement lorsque le package conteneur est entièrement signé. |
| Supprimer le package |
eSignatures ne supprime pas automatiquement les packages de la base de données une fois qu’ils ont atteint un état final. Ils sont stockés indéfiniment. Pour supprimer des packages de la base de données, les utilisateurs peuvent utiliser l’appel Supprimer le package. |
| Téléchargement de la preuve d’audit de corrélation de document |
Les ID de corrélation sont utilisés pour suivre les packages ou les documents entre plusieurs passes via l’application eSignatures. |
| Téléchargement de la preuve d’audit de corrélation de package |
Les ID de corrélation sont utilisés pour suivre les packages ou les documents entre plusieurs passes via l’application eSignatures. |
| Télécharger le document à partir du package |
Les documents signés dans un package peuvent être téléchargés un par un par un système externe à l’aide de cet appel. Chaque document est téléchargé au format PDF ou en tant que flux de fichiers XML, en fonction de la valeur du paramètre DocumentType. |
| Télécharger le package |
Le package contenant les documents signés peut être téléchargé par un système externe à l’aide de cet appel. |
| Vérification de l’audit du package |
Le xml de preuve d’audit d’un package peut être récupéré lorsque le package est entièrement signé. La même chose s’applique à un document : il fonctionne uniquement lorsque le package conteneur est entièrement signé. |
Ajouter un document au package
Cet appel ajoute un document à un package existant.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identificateur du package.
|
PackageId | True | string |
Package Unique Id |
|
Document
|
Document | string |
Document joint au format codé en base64. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
Langue à utiliser dans les textes de signature. |
|
|
DocumentName
|
DocumentName | string |
Nom du document à afficher dans le portail eSignatures. |
|
|
Numéro de page
|
PageNumber | integer |
Numéro de la page sur laquelle ajouter un emplacement de signature |
|
|
Largeur
|
Width | string |
Largeur |
|
|
Hauteur
|
Height | string |
Hauteur |
|
|
Gauche
|
Left | string |
Position à partir de la gauche de la page |
|
|
Haut
|
Top | string |
Position en haut de la page |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Référence unique à un champ de signature, un marqueur de texte ou un champ de texte. |
|
|
CorrelationId
|
CorrelationId | string |
ID qui indique les documents de ce package sont corrélés avec les documents qui ont été connectés par le passé dans d’autres packages. |
|
|
DocumentType
|
DocumentType | string |
Type de document qui sera signé. |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Référence donnée par l’application appelante. |
|
|
ErrorCode
|
ErrorCode | string |
Code d’erreur avec des informations de variable. |
|
|
Message
|
Message | string |
Texte détaillé du message d’erreur, non localisé |
|
|
Représentation
|
Representation | string |
Document de représentation attaché au format base64. Il doit s’agir de données PDF. |
|
|
RepresentationType
|
RepresentationType | string |
Type du document de représentation. |
|
|
TargetType
|
TargetType | string |
TargetType définit si une conversion supplémentaire en PDF/A doit être effectuée avant la signature. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
ID unique du document |
|
CreationTimestamp
|
CreationTimestamp | string |
Date et heure de création du flux. Format : AAAA-MM-DDThh :mm :ss+zz :zz |
|
Lieux
|
Locations | array of object |
Représente un emplacement possible pour une signature |
|
Id
|
Locations.Id | string |
ID unique pour cet emplacement |
|
Étiquette
|
Locations.Label | string |
Étiquette détectée ou spécifiée |
|
Numéro de page
|
Locations.PageNumber | integer |
Page sur laquelle l’emplacement a été trouvé. |
Ajouter une preuve à partir d’une source externe
Cet appel permet aux utilisateurs d’API d’ajouter des preuves supplémentaires d’une source externe à un emplacement sur un document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID unique du package
|
packageId | True | string |
ID unique du package |
|
Content
|
Content | string |
Contenu réel de la preuve. |
|
|
LocationId
|
LocationId | string |
Emplacement de la signature pour laquelle le contenu de preuve a été généré. |
|
|
Nom
|
Name | string |
Nom de la preuve. |
|
|
Type
|
Type | string |
Clé « type » lisible par l’ordinateur. Peut être choisi librement. |
|
|
Descriptif
|
Description | string |
Brève description lisible par l’homme de la preuve. |
|
|
adresse IP
|
IpAddress | string |
Adresse IP de l’utilisateur final de la source externe pour laquelle la preuve a été ajoutée. |
Créer un package
Cet appel crée un package vide, ce qui permet aux documents d’être ajoutés à celui-ci
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Type de contenu
|
Content-Type | True | string |
Type de contenu |
|
Initiateur
|
Initiator | string |
Adresse e-mail d’un utilisateur inscrit. |
|
|
PackageName
|
PackageName | string |
Nom du package, affiché dans le portail eSignatures et lors du téléchargement en tant que fichier zip. |
|
|
CallBackUrl
|
CallBackUrl | string |
URL de l’API REST qui sera appelée chaque fois qu’une action a été effectuée pour ce package. |
|
|
CorrelationId
|
CorrelationId | string |
ID qui indique les packages corrélés. |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
Code qui identifie un groupe de documents dans lequel le package doit être affiché. |
|
|
ThemeCode
|
ThemeCode | string |
Thème qui doit être appliqué au package |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Ce paramètre détermine si les packages peuvent être téléchargés à partir de WYSIWYS avant la signature. |
|
|
RéaffecterEnabled
|
ReassignEnabled | boolean |
Ce paramètre détermine si les packages peuvent être réaffectés à partir de WYSIWYS à un autre approbateur/signataire. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Ce paramètre détermine après combien de jours les URL d’action doivent expirer lorsqu’elles ne sont pas utilisées. |
|
|
ExpireyTimestamp
|
ExpiryTimestamp | string |
Date et heure à laquelle ce package expire et ne peut plus être signé. |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Référence donnée par l’application appelante. Ce paramètre n’est pas utilisé par le portail eSignatures. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
Ce champ est réservé à une utilisation ultérieure. Il peut être utilisé pour les extensions spécifiques au client pour s’intégrer à des services tiers, tels que la signature de carte de débit. |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
URL vers laquelle l’utilisateur final est redirigé après que tous les champs ont été signés avec la signature « face à face » ou lorsque tous les champs ont été rejetés. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
URL de l’API REST qui sera appelée lorsqu’un utilisateur final demande d’être averti. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Identificateur unique du package. |
|
CreationTimestamp
|
CreationTimestamp | string |
Date et heure de création du package en fonction du serveur. |
Créer un package instantané
Cet appel crée un package avec un document unique dans celui-ci et le prépare instantanément pour la signature
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Document
|
Document | byte |
Document joint au format codé en base64. Obligatoire, sauf si le format multipart est utilisé. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
Langue à utiliser dans les textes de signature. Actuellement pris en charge : en, nl, de, fr, es. |
|
|
DocumentName
|
DocumentName | string |
Nom du document et du package à afficher dans le portail eSignatures. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
ExternalPackageData |
|
|
Initiateur
|
Initiator | string |
Adresse e-mail d’un utilisateur inscrit |
|
|
Type
|
Type | string |
Signataire / Récepteur |
|
|
OrderIndex
|
OrderIndex | integer |
Ce nombre spécifie dans quel ordre les acteurs doivent exécuter leur action. |
|
|
Numéro de page
|
PageNumber | integer |
Numéro de la page sur laquelle ajouter un emplacement de signature |
|
|
Largeur
|
Width | string |
Largeur |
|
|
Hauteur
|
Height | string |
Hauteur |
|
|
Gauche
|
Left | string |
Position à partir de la gauche de la page |
|
|
Haut
|
Top | string |
Position en haut de la page |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Référence unique à un champ de signature, un marqueur de texte ou un champ de texte. |
|
|
SigningType
|
SigningType | string |
Type de signature utilisé dans la session de cet acteur. |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
Un ou plusieurs OID de types d’engagement. Ne peut être passé que lorsque la stratégie de signature est utilisée. |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Type de validation à exécuter pendant l’eID d’autres cartes à puce ou session de signature itsme. |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Définit l’eID ou d’autres cartes à puce autorisées à se connecter pendant cette session. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Détails de la stratégie de signature. |
|
|
Numéro de téléphone
|
Phonenumber | string |
Numéro de téléphone pour recevoir un OTP SMS. |
|
|
RedirectUrl
|
RedirectUrl | string |
URL vers laquelle l’utilisateur final est redirigé après la signature. |
|
|
SendNotifications
|
SendNotifications | boolean |
Les eSignatures peuvent envoyer des e-mails à toutes les personnes autorisées à signer. |
|
|
UserRoles
|
UserRoles | array of string |
Rôle ou fonction du signataire. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
Notice légale |
|
|
LegalNoticeText
|
LegalNoticeText | string |
Texte de avis juridique personnalisé dans le cas où aucun des trois avis juridiques prédéfinis ne s’applique. |
|
|
Adresse e-mail
|
EmailAddress | string |
Adresse e-mail |
|
|
Prénom
|
FirstName | string |
Prénom |
|
|
nom de famille
|
LastName | string |
nom de famille |
|
|
Naissance
|
BirthDate | string |
Naissance |
|
|
Language
|
Language | string |
Language |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
ExternalStakeholderReference |
|
|
CallBackUrl
|
CallBackUrl | string |
URL de l’API REST qui sera appelée chaque fois qu’une action a été effectuée pour ce package |
|
|
CorrelationId
|
CorrelationId | string |
ID qui indique quels packages ou documents sont corrélés |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
Le « code » qui identifie un groupe de documents dans lequel le document doit être affiché |
|
|
ThemeCode
|
ThemeCode | string |
Thème qui doit être appliqué au package |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Ce paramètre détermine si les packages peuvent être téléchargés à partir de WYSIWYS avant de signer |
|
|
RéaffecterEnabled
|
ReassignEnabled | boolean |
Ce paramètre détermine si les packages peuvent être réaffectés à partir de WYSIWYS à un autre approbateur/signataire. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Ce paramètre détermine après combien de jours les URL d’action doivent expirer lorsqu’elles ne sont pas utilisées. |
|
|
ExpireyTimestamp
|
ExpiryTimestamp | string |
Référence donnée par l’application appelante. Ce paramètre ne sera pas utilisé par le portail eSignatures |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Référence donnée par l’application appelante, ce paramètre ne sera pas utilisé par le portail eSignatures |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Référence donnée par l’application appelante, ce paramètre ne sera pas utilisé par le portail eSignatures |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
URL vers laquelle l’utilisateur final est redirigé après que tous les champs ont été signés avec la signature « visage à face » ou lorsque tous les champs ont été rejetés. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
URL de l’API REST qui sera appelée lorsqu’un utilisateur final demande d’être averti. Si aucune URL n’est fournie, aucun rappel n’est effectué |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
Comment gérer les fichiers PDF contenant des défauts mineurs |
|
|
Représentation
|
Representation | string |
Document de représentation attaché au format base64 |
|
|
RepresentationType
|
RepresentationType | string |
Le type du document de représentation doit être présent lorsque la représentation est remplie. Seul « application/pdf » est pris en charge. |
|
|
SigningTemplateCode
|
SigningTemplateCode | string |
Le modèle configuré dans le portail fournira toutes les informations nécessaires |
|
|
TargetType
|
TargetType | string |
TargetType définit si une conversion supplémentaire en PDF/A doit être effectuée avant la signature |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Identificateur unique du package. |
|
CreationTimestamp
|
CreationTimestamp | string |
Date et heure de création du package en fonction du serveur. |
Définir les informations de processus
Cette méthode de service web met à jour les personnes impliquées dans le processus (parties prenantes) et leur attribue des étapes qui doivent être prises.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID unique du package
|
id | True | string |
ID unique du package |
|
Type
|
Type | string |
Type |
|
|
OrderIndex
|
OrderIndex | string |
Ce nombre spécifie dans quel ordre les acteurs doivent exécuter leur action. |
|
|
LocationIds
|
LocationIds | array of string |
ID d’emplacement où une signature doit être placée par cette personne. |
|
|
SigningType
|
SigningType | string |
Type de signature utilisé dans la session de cet acteur. |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
Un ou plusieurs OID de types d’engagement. Ne peut être passé que lorsque la stratégie de signature est utilisée. |
|
|
MandatedSignerValidation
|
MandatedSignerValidation | string |
Type de validation à exécuter pendant l’eID d’autres cartes à puce ou session de signature itsme. |
|
|
MandatedSignerIds
|
MandatedSignerIds | array of string |
Définit l’eID ou d’autres cartes à puce autorisées à se connecter pendant cette session. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Détails de la stratégie de signature. |
|
|
Numéro de téléphone
|
Phonenumber | string |
Numéro de téléphone pour recevoir un OTP SMS. |
|
|
RedirectURL
|
RedirectURL | string |
URL vers laquelle l’utilisateur final est redirigé après la signature ou le rejet. La redirection se produit immédiatement après la signature ou le rejet. |
|
|
SendNotifications
|
SendNotifications | boolean |
Les eSignatures peuvent envoyer des e-mails aux acteurs dont l’action est requise, par exemple la signature |
|
|
UserRoles
|
UserRoles | array of string |
ID d’emplacement où une signature doit être placée par cette personne. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
Les 3 valeurs pointent vers les 3 avis juridiques intégrés à l’application. Ceux-ci peuvent être modifiés dans l’index de configuration. |
|
|
LegalNoticetext
|
LegalNoticetext | string |
Texte de avis juridique personnalisé dans le cas où aucun des trois avis juridiques prédéfinis ne s’applique |
|
|
Adresse e-mail
|
EmailAddress | string |
Adresse électronique |
|
|
Prénom
|
FirstName | string |
Prénom |
|
|
Language
|
Language | string |
Langue de l’interface utilisateur de cette partie prenantes. Actuellement pris en charge : en, nl, de, fr, es. |
|
|
nom de famille
|
LastName | string |
Nom de famille |
|
|
Naissance
|
BirthDate | string |
Date de naissance au format : AAAA-MM-DD |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
Référence donnée par l’application appelante. Ce paramètre n’est pas utilisé par le portail eSignatures. |
Définir l’état du package
Au moyen de l’appel Définir l’état du package, vous pouvez modifier l’état d’un package.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID unique pour le package de signature
|
Id | True | string |
ID unique pour le package de signature |
|
Statut
|
Status | string |
En attente / Révoqué |
Retours
Description du package affiché à l’utilisateur du portail eSignatures en tant que nom de fichier.
- Corps
- PackageStatus
Envoyer des rappels de package
La stratégie d’entreprise peut exiger qu’un document soit géré dans un intervalle de temps donné. Le déclenchement de l’appel « envoyer des rappels » recherche tout le monde qui n’a pas signé et envoie une notification supplémentaire en tant que rappel.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID unique du package
|
PackageId | True | string |
ID unique du package |
Horodatage d’expiration
Un package peut avoir l’état Expiré lorsqu’un package a passé une valeur pour le paramètre ExpiryTimestamp dans l’appel Create Package. Un tel package ne peut plus être signé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID unique du package
|
id | True | string |
ID unique du package |
|
ExpireyTimestamp
|
ExpiryTimestamp | date-time |
Ignorer les signataires
Cet appel ignore tous les signataires qui n’ont pas encore signé et définit leur état sur « Ignoré », ce qui entraîne la marque « Terminé » dans le package complet.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID unique du package
|
PackageId | True | string |
ID unique du package |
Liste des packages
Obtenir la liste des packages avec leur état actuel
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Jeton de continuation / guid pour savoir quelle page retourner.
|
ContinuationToken | string |
Jeton de continuation / guid pour savoir quelle page retourner. DOIT ÊTRE VIDE ou le jeton retourné à partir d’un appel PRÉCÉDENT. |
|
|
Obtient ou définit la quantité maximale.
|
MaxQuantity | integer |
Obtient ou définit la quantité maximale. |
|
|
Obtient ou définit le champ de tri.
|
SortField | string |
Obtient ou définit le champ de tri. |
|
|
Obtient ou définit le champ de tri.
|
SortOrder | string |
Obtient ou définit le champ de tri. |
|
|
Obtient ou définit la date de création antérieure.
|
CreatedBeforeDate | string |
Obtient ou définit la date de création antérieure. |
|
|
Obtient ou définit l’état.
|
Status | string |
Obtient ou définit l’état. |
|
|
Obtient ou définit la date de création.
|
createdAfterDate | string |
Obtient ou définit la date de création. |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ContinuationToken
|
ContinuationToken | string |
ContinuationToken |
|
MaxQuantity
|
MaxQuantity | integer |
MaxQuantity |
|
Total
|
Total | integer |
Total |
|
Objets
|
Items | array of Package |
Obtenir les emplacements de signature
Cet appel fournit une vue d’ensemble de tous les emplacements de signature à l’intérieur des documents au sein d’un package.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID du champ de signature
|
Id | True | string |
ID du champ de signature |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Documents
|
Documents | array of object | |
|
DocumentId
|
Documents.DocumentId | string |
ID unique du document |
|
ExternalDocumentReference
|
Documents.ExternalDocumentReference | string |
Référence externe pour l’identification. Veillez à utiliser une valeur unique. |
|
Lieux
|
Documents.Locations | array of object |
Représente un emplacement possible pour une signature |
|
Id
|
Documents.Locations.Id | string |
ID unique pour cet emplacement. |
|
Étiquette
|
Documents.Locations.Label | string |
Valeur que vous avez entrée en tant que paramètre De requête. |
|
Numéro de page
|
Documents.Locations.PageNumber | integer |
Numéro de la page sur laquelle la signature est disponible. |
Obtenir l’état du package
Récupère l’état actuel du package et de ses documents.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID unique pour le package de signature
|
Id | True | string |
ID unique pour le package de signature |
Retours
Description du package affiché à l’utilisateur du portail eSignatures en tant que nom de fichier.
- Corps
- PackageStatus
Preuve d’audit du package avec l’ID de document
Le xml de preuve d’audit d’un package peut être récupéré lorsque le package est entièrement signé. La même chose s’applique à un document : il fonctionne uniquement lorsque le package conteneur est entièrement signé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID unique du package
|
packageId | True | string |
ID unique du package |
|
ID unique du document
|
documentId | True | string |
ID unique du document |
Retours
- Corps
- Content
Supprimer le package
eSignatures ne supprime pas automatiquement les packages de la base de données une fois qu’ils ont atteint un état final. Ils sont stockés indéfiniment. Pour supprimer des packages de la base de données, les utilisateurs peuvent utiliser l’appel Supprimer le package.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID unique du package
|
id | True | string |
ID unique du package |
Téléchargement de la preuve d’audit de corrélation de document
Les ID de corrélation sont utilisés pour suivre les packages ou les documents entre plusieurs passes via l’application eSignatures.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identificateur de corrélation.
|
correlationId | True | string |
Identificateur de corrélation. |
Retours
- Corps
- Content
Téléchargement de la preuve d’audit de corrélation de package
Les ID de corrélation sont utilisés pour suivre les packages ou les documents entre plusieurs passes via l’application eSignatures.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Identificateur de corrélation.
|
correlationId | True | string |
Identificateur de corrélation. |
Retours
- Corps
- Content
Télécharger le document à partir du package
Les documents signés dans un package peuvent être téléchargés un par un par un système externe à l’aide de cet appel. Chaque document est téléchargé au format PDF ou en tant que flux de fichiers XML, en fonction de la valeur du paramètre DocumentType.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID unique pour le package de signature
|
id | True | string |
ID unique pour le package de signature |
|
ID unique du document contenu dans le package
|
documentId | True | string |
ID unique du document contenu dans le package |
Retours
- response
- binary
Télécharger le package
Le package contenant les documents signés peut être téléchargé par un système externe à l’aide de cet appel.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID unique du package
|
id | True | string |
ID unique du package |
Retours
- response
- binary
Vérification de l’audit du package
Le xml de preuve d’audit d’un package peut être récupéré lorsque le package est entièrement signé. La même chose s’applique à un document : il fonctionne uniquement lorsque le package conteneur est entièrement signé.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID unique du package
|
packageId | True | string |
ID unique du package |
Retours
- Corps
- Content
Définitions
Package
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Id
|
Id | string | |
|
PackageStatus
|
PackageStatus | string | |
|
ExternalPackageReference
|
ExternalPackageReference | string |
PackageDocument
Détails de chacun des documents du package
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
ID unique du document |
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Retourne la référence externe de ce document lors de son passage via l’appel de package Add document. |
|
DocumentName
|
DocumentName | string |
Nom du document |
|
DocumentType
|
DocumentType | string |
Type de document dans le package. |
PackageStatus
Description du package affiché à l’utilisateur du portail eSignatures en tant que nom de fichier.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
PackageName
|
PackageName | string |
Description du package affiché à l’utilisateur du portail eSignatures en tant que nom de fichier. |
|
CreationTimestamp
|
CreationTimestamp | string |
Date et heure de création du package en fonction du serveur. |
|
Initiateur
|
Initiator | string |
Champ initiateur du package tel qu’il a été passé au moment de la création. |
|
ExpireyTimestamp
|
ExpiryTimestamp | string |
Heure au format UTC à laquelle le document expire. Peut être null. |
|
ExternalPackageReference
|
ExternalPackageReference | string |
Retourne l’ID de référence externe du package tel qu’il a été passé au moment de la création. |
|
F2FSigningUrl
|
F2FSigningUrl | string |
Lien vers le package qui permet de choisir à partir de toutes les sessions de signature à la fois. |
|
PackageStatus
|
PackageStatus | string |
État du package dans son ensemble : |
|
PackageDocuments
|
PackageDocuments | array of PackageDocument |
Détails de chacun des documents du package. |
|
Parties prenantes
|
Stakeholders | array of object |
Détails pour chacune des personnes qui interagiront avec le package. |
|
Type
|
Stakeholders.Type | string |
Type de partie prenantes : Personne, PersonGroup ou ContactGroup. |
|
PersonGroupName
|
Stakeholders.PersonGroupName | string |
Nom du groupe de personnes. Retourné uniquement si Type a été défini sur PersonGroup dans la requête. |
|
ContactGroupCode
|
Stakeholders.ContactGroupCode | string |
Code du groupe de contacts. Retourné uniquement si Le type a été défini sur ContactGroup dans la requête. |
|
Adresse e-mail
|
Stakeholders.EmailAddress | string |
Adresse e-mail du signataire. |
|
ExternalStakeholderReference
|
Stakeholders.ExternalStakeholderReference | string |
Référence externe identifiant cette personne dans le système externe. |
|
Id de partie prenante
|
Stakeholders.StakeholderId | string |
ID unique. |
|
Acteurs
|
Stakeholders.Actors | array of object |
Détails de toutes les étapes à suivre. |
|
ActorId
|
Stakeholders.Actors.ActorId | string |
ID unique pour cette combinaison d’actions, de parties prenantes et de document. |
|
ActionUrl
|
Stakeholders.Actors.ActionUrl | string |
URL que cette personne peut ouvrir pour interagir avec le package. |
|
ActionUrls
|
Stakeholders.Actors.ActionUrls | array of object |
Tableau d’URL que les différentes personnes de PersonGroup ou ContactGroup peuvent ouvrir pour interagir avec le package. |
|
Adresse e-mail
|
Stakeholders.Actors.ActionUrls.EmailAddress | string |
Adresse e-mail de la personne. |
|
URL
|
Stakeholders.Actors.ActionUrls.Url | string |
URL que cette personne peut ouvrir pour interagir avec le package. |
|
ActorStatus
|
Stakeholders.Actors.ActorStatus | string |
Brouillon (le package a l’état Brouillon) |
|
Type
|
Stakeholders.Actors.Type | string |
Signataire / Récepteur |
|
CompletedBy
|
Stakeholders.Actors.CompletedBy | string |
Nom de l’utilisateur final qui a terminé l’action. |
|
CompletedTimestamp
|
Stakeholders.Actors.CompletedTimestamp | string |
Horodatage du moment où cette action a été terminée. |
|
Reason
|
Stakeholders.Actors.Reason | string |
Retourne le texte entré par la personne qui a modifié l’état d’un package en état final (par exemple, un rejet). |
|
Lieux
|
Stakeholders.Actors.Locations | array of object |
Représente un emplacement possible pour une signature. |
|
Id
|
Stakeholders.Actors.Locations.Id | string |
ID unique pour cet emplacement |
|
UsedSigningType
|
Stakeholders.Actors.Locations.UsedSigningType | string |
Retourne le type de signature utilisé pour signer le document. |
Content
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Téléchargements
|
uploads | array of object | |
|
télécharger
|
uploads.upload | array of object | |
|
start
|
uploads.upload.start | date-time | |
|
end
|
uploads.upload.end | date-time | |
|
Signatures
|
uploads.upload.signatures | array of object | |
|
Preuves
|
uploads.upload.signatures.proofs | array of object | |
|
nom
|
uploads.upload.signatures.proofs.proof.name | string | |
|
type
|
uploads.upload.signatures.proofs.proof.type | string | |
|
index
|
uploads.upload.signatures.proofs.proof.index | boolean | |
|
ipAddress
|
uploads.upload.signatures.proofs.proof.ipAddress | string | |
|
locationId
|
uploads.upload.signatures.locationId | string | |
|
index
|
uploads.indexes | array of object | |
|
identifier
|
uploads.indexes.index.identifier | boolean | |
|
contenu
|
uploads.indexes.index.content | string | |
|
packageCorrelationId
|
uploads.packageCorrelationId | string | |
|
packageId
|
uploads.packageId | string |
binaire
Il s’agit du type de données de base "binaire".