Partager via

Nitro Sign Enterprise Verified (préversion)

Nitro Sign Enterprise Verified est une solution de signature numérique renommée qui offre une grande quantité de méthodes de signature et de conformité aux réglementations nationales les plus strictes (inter). NSEV vous permet de transformer n’importe quel processus basé sur 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.

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 de Nitro
URL https://www.gonitro.com/support
Messagerie électronique service@gonitro.com
Métadonnées du connecteur
Éditeur Nitro Software Belgique NV
Site web https://www.gonitro.com
Politique de confidentialité https://www.gonitro.com/legal/privacy-policy
Catégories Opérations informatiques ; Productivité

Nitro Sign Enterprise Verified Connector

Nitro Software, spécialiste de Smart Document Solutions, a rendu le Connecteur vérifié Nitro Sign Enterprise 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. Nitro Sign Enterprise Verified - précédemment appelé Nitro Sign Premium et Connective eSignatures.

Prerequisites

Pour commencer à utiliser le connecteur, un abonnement existant à Nitro Sign Enterprise Verified est requis. Contactez votre contact chez Nitro Software ou accédez à notre page d’aide et de support sur notre site web pour recevoir les informations d’identification.

Documentation

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 contactez l’équipe de support via notre page d’aide et de support ou la boîte aux lettres de support : mailto :service@gonitro.com. La documentation de l’API est également disponible au format Postman.

Un glossaire est disponible pour expliquer les différents termes utilisés dans cette documentation

Opérations prises en charge

Le connecteur Nitro Sign Enterprise Verified est basé sur l’API v4 de Nitro Sign Enterprise Verified. L’API 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
Packages Obtenir tous les packages
Obtenir un package par ID
Obtenir l’état du package
Créer un package (standard ou instantané)
Supprimer un package par ID
Mettre à jour l’état d’un package
Obtenir la date d’expiration d’un package
Mettre à jour la date d’expiration d’un package
Ignorer les signataires
Envoyer des rappels
Télécharger un package
Télécharger la piste d’audit d’un package
Documents Ajouter un document à un package
Télécharger un document signé à partir d’un package
Parties prenantes Supprimer une partie prenante par ID
Obtenir toutes les parties prenantes d’un package
Ajouter une partie prenantes à un package
Processus Obtenir toutes les étapes de processus d’un package
Processus Ajouter une étape dans le processus du package
Processus Remplacer les étapes de processus d’un package
Processus Obtenir toutes les actions d’une étape de processus
Processus Supprimer une étape de processus et tous ses acteurs
Processus Ajouter un acteur à une étape de processus
Processus Obtenir toutes les actions de l’étape de processus actuelle
Other Obtenir toutes les langues activées dans l’application
Obtenir tous les thèmes qui peuvent être affectés à un package
Obtenir tous les groupes de documents auxquels un package peut être affecté
Obtenir toutes les méthodes de signature configurées

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
Hôte de signe Nitro ficelle hôte et chemin d’accès à votre environnement Nitro Sign, par exemple contoso.sign.gonitro.com/esig 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 acteur à une étape de processus

Ajoute un acteur à une étape de processus.
Ajouter un document à un package

Ajoute un document à un package existant.
Ajouter une partie prenantes à un package

Ajoute une partie prenantes au package
Ajouter une étape dans le processus du package

Ajoute un ensemble d’actions au processus du package.
Créer un package (standard ou instantané)

Crée un package. Par défaut, le package est créé en tant que brouillon. Pour créer un package instantané qui est immédiatement prêt pour la signature, définissez la status propriété Pendingsur .

Note: Le POST /packages point de terminaison vous permet de créer des packages standard et instantanés.
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.
Ignorer les signataires

Cet appel ignore tous les signataires qui n’ont pas encore terminé et définit leur état sur « Ignoré », ce qui entraîne la marque « Terminé » du package complet.
Mettre à jour la date d’expiration d’un package

Mettre à jour la date d’expiration d’un package
Mettre à jour l’état du package

Met à jour l’état d’un package.
Obtenir la date d’expiration d’un package

Récupérer la date d’expiration d’un package
Obtenir l’état du package

Récupère l’état actuel du package.
Obtenir tous les packages

Obtient tous les packages, ceux-ci sont triés par creationDate
Obtenir toutes les actions de l’étape de processus actuelle

Obtient l’ensemble actuel d’actions qui peuvent être effectuées en parallèle.
Obtenir toutes les actions d’une étape de processus

Obtient un ensemble particulier d’actions qui peuvent être effectuées en parallèle à partir du processus.
Obtenir toutes les parties prenantes d’un package

Récupère les parties prenantes du package
Obtenir toutes les étapes de processus

Obtient toutes les actions qui devront être effectuées sur le package.
Obtenir un package par ID

Récupère un package par son ID.
Remplacer les étapes de processus d’un package

Remplace tous les acteurs d’un package à l’aide d’un tableau 2D où chaque ensemble d’acteurs est des actions qui peuvent être effectuées en parallèle.
Retourner toutes les méthodes de signature actuellement configurées

Retourne toutes les méthodes de signature actuellement configurées
Récupérer tous les groupes de documents auxquels les packages peuvent être affectés

Récupère tous les groupes de documents auxquels les packages peuvent être affectés
Récupérer tous les thèmes qui peuvent être affectés à un package

Récupère tous les thèmes qui peuvent être affectés à un package. Possible de pager le résultat en fournissant une valeur MaxQuantity et une continuationToken
Récupérer toutes les langues activées dans l’application

Récupère toutes les langues activées dans l’application
Supprimer le package par ID

Supprime un package par son ID.
Supprimer les parties prenantes par ID

Supprime une partie prenantes par son ID.
Supprimer une étape de processus et tous ses acteurs

Supprime une étape de processus et tous ses acteurs.
Télécharger la piste d’audit du package

Téléchargez une piste d’audit signée sur la durée de vie d’un package.
Télécharger le document à partir du package

Téléchargez un document signé à partir d’un package. Chaque document sera téléchargé sous forme de fichier PDF ou XML.
Télécharger le package

Utilisé pour télécharger tous les documents d’un certain package en tant que fichier Zip.

Ajouter un acteur à une étape de processus

ID d’opération :
Process_StepPost

Ajoute un acteur à une étape de processus.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package
Index de l’étape de processus
 stepIndex True integer

Index de l’étape de processus
Type
 Type True string

Type d’action devant être effectué sur un package
Id de partie prenante
 StakeholderId True string

Identificateur d’une partie prenante dans le package
SuppressNotifications
 SuppressNotifications boolean

Supprimer les notifications pour l’acteur
RedirectUrl
 RedirectUrl url

URL de redirection une fois l’action de l’acteur terminée
Id
 Id string

Identificateur d’un élément existant. S’il est utilisé, tous les autres champs doivent être vides.
Type
 Type string

Type d’élément
ExternalReference
 ExternalReference string

Référence externe pour le package
Page
 Page integer

Numéro de page du document
Haut
 Top number

Position supérieure en pixels
Gauche
 Left number

Position gauche en pixels
Largeur
 Width number

Largeur de l’élément
Hauteur
 Height number

Hauteur de l’élément
DocumentId
 DocumentId string

Identificateur du document dans le package
SigningMethods
 SigningMethods array of string
Nom
 Name string

Nom de l’avis juridique à ajouter au champ de signature.
Content
 Content string

Contenu d’avis juridique personnalisé.
Language
 Language string

Code ISO de 2 lettres d’un pays (ISO 639-1)

Retours

Corps
Response.Actor

Ajouter un document à un package

ID d’opération :
Documents_AddToPackage

Ajoute un document à un package existant.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package
Nom
 Name True string

Nom du document
IsOptional
 IsOptional boolean

Indique si le document doit être facultatif pour la signature
Language
 Language True string

Code ISO de 2 lettres d’un pays (ISO 639-1)
ExternalReference
 ExternalReference string

Référence externe pour le package
ProofCorrelationId
 ProofCorrelationId string

Identificateur global unique
TargetType
 TargetType string

Fonctionne uniquement lorsque le serveur est configuré pour les conversions de documents.
TargetFormat
 TargetFormat string

Le format cible définit si une conversion supplémentaire doit être effectuée.
PdfErrorHandling
 PdfErrorHandling string

Comment gérer les fichiers PDF contenant des défauts mineurs
ContentType
 ContentType True string

Type MIME du document
Base64Data
 Base64Data True byte

Contenu de document encodé en base64
Type
 Type True string

Type d’élément
ExternalReference
 ExternalReference string

Référence externe pour le package
Page
 Page integer

Numéro de page du document
Haut
 Top number

Position supérieure en pixels
Gauche
 Left number

Position gauche en pixels
Largeur
 Width number

Largeur de l’élément
Hauteur
 Height number

Hauteur de l’élément
SigningMethods
 SigningMethods array of string
Nom
 Name string

Nom de l’avis juridique à ajouter au champ de signature.
Content
 Content string

Contenu d’avis juridique personnalisé.
Language
 Language string

Code ISO de 2 lettres d’un pays (ISO 639-1)

Retours

Corps
Response.Document

Ajouter une partie prenantes à un package

ID d’opération :
Packages_AddStakeholder

Ajoute une partie prenantes au package

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package
Type
 Type True string

Type de partie prenante
ExternalReference
 ExternalReference string

Référence externe pour le package
Language
 Language True string

Code ISO de 2 lettres d’un pays (ISO 639-1)
Prénom
 FirstName string

Prénom de la partie prenante
nom de famille
 LastName True string

Nom de la partie prenantes
Adresse e-mail
 EmailAddress True email

Une adresse e-mail
Naissance
 BirthDate date
Numéro de téléphone
 PhoneNumber string

Un numéro de téléphone
AdditionalProperties
 AdditionalProperties object

Propriétés supplémentaires configurables des parties prenantes
Type
 Type True string

Type d’action devant être effectué sur un package
SuppressNotifications
 SuppressNotifications boolean

Supprimer les notifications pour l’acteur
RedirectUrl
 RedirectUrl url

URL de redirection une fois l’action de l’acteur terminée
Type de redirection
 RedirectType string
BackButtonUrl
 BackButtonUrl url

URL vers laquelle l’utilisateur est envoyé après la fermeture de la session
Id
 Id string

Identificateur d’un élément existant. S’il est utilisé, tous les autres champs doivent être vides.
Type
 Type string

Type d’élément
ExternalReference
 ExternalReference string

Référence externe pour le package
Page
 Page integer

Numéro de page du document
Haut
 Top number

Position supérieure en pixels
Gauche
 Left number

Position gauche en pixels
Largeur
 Width number

Largeur de l’élément
Hauteur
 Height number

Hauteur de l’élément
DocumentId
 DocumentId string

Identificateur du document dans le package
SigningMethods
 SigningMethods array of string
Nom
 Name string

Nom de l’avis juridique à ajouter au champ de signature.
Content
 Content string

Contenu d’avis juridique personnalisé.
Language
 Language string

Code ISO de 2 lettres d’un pays (ISO 639-1)

Retours

Corps
Response.Stakeholder

Ajouter une étape dans le processus du package

ID d’opération :
Process_PostStep

Ajoute un ensemble d’actions au processus du package.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package
Type
 Type True string

Type d’action devant être effectué sur un package
Id de partie prenante
 StakeholderId True string

Identificateur d’une partie prenante dans le package
SuppressNotifications
 SuppressNotifications boolean

Supprimer les notifications pour l’acteur
RedirectUrl
 RedirectUrl url

URL de redirection une fois l’action de l’acteur terminée
Id
 Id string

Identificateur d’un élément existant. S’il est utilisé, tous les autres champs doivent être vides.
Type
 Type string

Type d’élément
ExternalReference
 ExternalReference string

Référence externe pour le package
Page
 Page integer

Numéro de page du document
Haut
 Top number

Position supérieure en pixels
Gauche
 Left number

Position gauche en pixels
Largeur
 Width number

Largeur de l’élément
Hauteur
 Height number

Hauteur de l’élément
DocumentId
 DocumentId string

Identificateur du document dans le package
SigningMethods
 SigningMethods array of string
Nom
 Name string

Nom de l’avis juridique à ajouter au champ de signature.
Content
 Content string

Contenu d’avis juridique personnalisé.
Language
 Language string

Code ISO de 2 lettres d’un pays (ISO 639-1)

Retours

Ensemble d’acteurs dans une étape de processus.

response
array of Response.Actor

Créer un package (standard ou instantané)

ID d’opération :
Packages_CreatePackage

Crée un package. Par défaut, le package est créé en tant que brouillon. Pour créer un package instantané qui est immédiatement prêt pour la signature, définissez la status propriété Pendingsur .

Note: Le POST /packages point de terminaison vous permet de créer des packages standard et instantanés.

Paramètres

Nom Clé Obligatoire Type Description
Nom
 Name True string

Nom du package
Initiateur
 Initiator True email

Une adresse e-mail
ExternalReference
 ExternalReference string

Référence externe pour le package
Statut
 Status string

État du package créé.

  • Permet "Draft" de créer un package standard qui peut être modifié avant l’envoi.
  • Permet "Pending" de créer un package instantané qui est immédiatement prêt pour la signature.
DocumentGroupCode
 DocumentGroupCode string

Code de groupe de documents pour le package
ExpireyDate
 ExpiryDate date-time

Valeur date/heure au format ISO 8601
Nom
 Name True string

Nom du document
IsOptional
 IsOptional boolean

Indique si le document doit être facultatif pour la signature
Language
 Language True string

Code ISO de 2 lettres d’un pays (ISO 639-1)
ExternalReference
 ExternalReference string

Référence externe pour le package
ProofCorrelationId
 ProofCorrelationId string

Identificateur global unique
TargetType
 TargetType string

Fonctionne uniquement lorsque le serveur est configuré pour les conversions de documents.
TargetFormat
 TargetFormat string

Le format cible définit si une conversion supplémentaire doit être effectuée.
PdfErrorHandling
 PdfErrorHandling string

Comment gérer les fichiers PDF contenant des défauts mineurs
ContentType
 ContentType True string

Type MIME du document
Base64Data
 Base64Data True byte

Contenu de document encodé en base64
Type
 Type True string

Type d’élément
Page
 Page integer

Numéro de page du document
Haut
 Top number

Position supérieure en pixels
Gauche
 Left number

Position gauche en pixels
Largeur
 Width number

Largeur de l’élément
Hauteur
 Height number

Hauteur de l’élément
SigningMethods
 SigningMethods array of string
Nom
 Name string

Nom de l’avis juridique à ajouter au champ de signature.
Content
 Content string

Contenu d’avis juridique personnalisé.
Type
 Type True string

Type de partie prenante
ExternalReference
 ExternalReference string

Référence externe pour le package
Language
 Language True string

Code ISO de 2 lettres d’un pays (ISO 639-1)
Prénom
 FirstName string

Prénom de la partie prenante
nom de famille
 LastName True string

Nom de la partie prenantes
Adresse e-mail
 EmailAddress True email

Une adresse e-mail
Naissance
 BirthDate date
Numéro de téléphone
 PhoneNumber string

Un numéro de téléphone
AdditionalProperties
 AdditionalProperties object

Propriétés supplémentaires configurables des parties prenantes
Type
 Type True string

Type d’action devant être effectué sur un package
SuppressNotifications
 SuppressNotifications boolean

Supprimer les notifications pour l’acteur
RedirectUrl
 RedirectUrl url

URL de redirection une fois l’action de l’acteur terminée
Type de redirection
 RedirectType string
BackButtonUrl
 BackButtonUrl url

URL vers laquelle l’utilisateur est envoyé après la fermeture de la session
ProcessStep
 ProcessStep integer

Numéro d’étape du processus
DocumentIndex
 DocumentIndex True integer

Index du document dans le package (à partir de 0) : disponible uniquement dans le point de terminaison Créer un package
Type
 Type True string

Type d’élément
Page
 Page integer

Numéro de page du document
Haut
 Top number

Position supérieure en pixels
Gauche
 Left number

Position gauche en pixels
Largeur
 Width number

Largeur de l’élément
Hauteur
 Height number

Hauteur de l’élément
SigningMethods
 SigningMethods True array of string
Nom
 Name string

Nom de l’avis juridique à ajouter au champ de signature.
Content
 Content string

Contenu d’avis juridique personnalisé.
ThemeCode
 ThemeCode string

Identificateur du thème du package
CallBackUrl
 CallBackUrl url

URL de rappel une fois les actions effectuées
NotificationCallBackUrl
 NotificationCallBackUrl url

URL de rappel lorsqu’un signataire demande une nouvelle URL de signature
DefaultRedirectUrl
 DefaultRedirectUrl url

URL de redirection après la fin de l’action
F2fRedirectUrl
 F2fRedirectUrl url

URL de redirection après la signature face à face
IsUnsignedContentDownloadable
 IsUnsignedContentDownloadable boolean

Indique si le contenu non signé peut être téléchargé
IsReassignEnabled
 IsReassignEnabled boolean

Indique si la réaffectation est activée

Retours

Corps
Response.Package.Get

Envoyer des rappels de package

ID d’opération :
Packages_SendReminders

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
Identificateur unique du package
 packageId True string

Identificateur unique du package

Ignorer les signataires

ID d’opération :
Packages_SkipSigners

Cet appel ignore tous les signataires qui n’ont pas encore terminé et définit leur état sur « Ignoré », ce qui entraîne la marque « Terminé » du package complet.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package

Mettre à jour la date d’expiration d’un package

ID d’opération :
Packages_PutExpiryDate

Mettre à jour la date d’expiration d’un package

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package
ExpireyTimestamp
 ExpiryTimestamp date-time

Valeur date/heure au format ISO 8601

Mettre à jour l’état du package

ID d’opération :
Packages_UpdateStatus

Met à jour l’état d’un package.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package
body
 body True string

Obtenir la date d’expiration d’un package

ID d’opération :
Packages_GetExpiryDate

Récupérer la date d’expiration d’un package

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package

Retours

Valeur date/heure au format ISO 8601

response
Common.DateTime

Obtenir l’état du package

ID d’opération :
Packages_GetStatus

Récupère l’état actuel du package.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package

Retours

Corps
Response.Package.Status

Obtenir tous les packages

ID d’opération :
Packages_Get

Obtient tous les packages, ceux-ci sont triés par creationDate

Paramètres

Nom Clé Obligatoire Type Description
Numéro de page à récupérer
 pageNumber integer

Numéro de page à récupérer
Nombre d’éléments par page
 pageSize integer

Nombre d’éléments par page
Retourner des packages créés avant cette date
 createdBefore date-time

Retourner des packages créés avant cette date
Retourner des packages créés après cette date
 createdAfter date-time

Retourner des packages créés après cette date
État des packages à filtrer
 status string

État des packages à filtrer
Code de groupe de documents pour filtrer les packages
 documentGroupCode string

Code de groupe de documents pour filtrer les packages
E-mail de l’initiateur de package à filtrer
 initiator email

E-mail de l’initiateur de package à filtrer
Nom du package à filtrer
 packageName string

Nom du package à filtrer
Référence externe aux packages de filtre
 externalReference string

Référence externe aux packages de filtre
Spécifier la façon dont le résultat est trié, la valeur par défaut est décroissante
 sort string

Spécifier la façon dont le résultat est trié, la valeur par défaut est décroissante

Retours

Nom Chemin d’accès Type Description
Numéro de page
 PageNumber integer

Numéro de page actuel
PageSize
 PageSize integer

Nombre d’éléments par page
TotalPages
 TotalPages integer

Nombre total de pages
TotalItems
 TotalItems integer

Nombre total d’éléments
Objets
 Items array of Response.Package.Get

Obtenir toutes les actions de l’étape de processus actuelle

ID d’opération :
Process_GetCurrentStep

Obtient l’ensemble actuel d’actions qui peuvent être effectuées en parallèle.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package

Retours

Nom Chemin d’accès Type Description
Objets
 Items array of Response.Actor

Obtenir toutes les actions d’une étape de processus

ID d’opération :
Process_GetStep

Obtient un ensemble particulier d’actions qui peuvent être effectuées en parallèle à partir du processus.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package
Index de l’étape de processus
 stepIndex True integer

Index de l’étape de processus

Retours

Nom Chemin d’accès Type Description
Objets
 Items array of Response.Actor

Obtenir toutes les parties prenantes d’un package

ID d’opération :
Packages_GetStakeholders

Récupère les parties prenantes du package

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package

Retours

response
array of Response.Stakeholder

Obtenir toutes les étapes de processus

ID d’opération :
Process_Get

Obtient toutes les actions qui devront être effectuées sur le package.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package

Retours

Nom Chemin d’accès Type Description
array of array
items
 array of Response.Actor

Ensemble d’acteurs dans une étape de processus.

Obtenir un package par ID

ID d’opération :
Packages_GetPackage

Récupère un package par son ID.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package

Retours

Corps
Response.Package.Get

Remplacer les étapes de processus d’un package

ID d’opération :
Process_Put

Remplace tous les acteurs d’un package à l’aide d’un tableau 2D où chaque ensemble d’acteurs est des actions qui peuvent être effectuées en parallèle.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package
Type
 Type True string

Type d’action devant être effectué sur un package
Id de partie prenante
 StakeholderId True string

Identificateur d’une partie prenante dans le package
SuppressNotifications
 SuppressNotifications boolean

Supprimer les notifications pour l’acteur
RedirectUrl
 RedirectUrl url

URL de redirection une fois l’action de l’acteur terminée
Id
 Id string

Identificateur d’un élément existant. S’il est utilisé, tous les autres champs doivent être vides.
Type
 Type string

Type d’élément
ExternalReference
 ExternalReference string

Référence externe pour le package
Page
 Page integer

Numéro de page du document
Haut
 Top number

Position supérieure en pixels
Gauche
 Left number

Position gauche en pixels
Largeur
 Width number

Largeur de l’élément
Hauteur
 Height number

Hauteur de l’élément
DocumentId
 DocumentId string

Identificateur du document dans le package
SigningMethods
 SigningMethods array of string
Nom
 Name string

Nom de l’avis juridique à ajouter au champ de signature.
Content
 Content string

Contenu d’avis juridique personnalisé.
Language
 Language string

Code ISO de 2 lettres d’un pays (ISO 639-1)

Retourner toutes les méthodes de signature actuellement configurées

ID d’opération :
GetAllSigningMethods

Retourne toutes les méthodes de signature actuellement configurées

Paramètres

Nom Clé Obligatoire Type Description
renvoyer uniquement les méthodes de signature actives/inactives
 isActive boolean

renvoyer uniquement les méthodes de signature actives/inactives

Retours

response
array of ConfiguredSigningMethod

Récupérer tous les groupes de documents auxquels les packages peuvent être affectés

ID d’opération :
GetDocumentGroups

Récupère tous les groupes de documents auxquels les packages peuvent être affectés

Paramètres

Nom Clé Obligatoire Type Description
Nom du groupe de documents (ou partie) à rechercher
 name string

Nom du groupe de documents (ou partie) à rechercher

Retours

Nom Chemin d’accès Type Description
DocumentGroups
 DocumentGroups array of object

Liste des groupes de documents
Code
 DocumentGroups.Code string

Code du groupe de documents
Nom
 DocumentGroups.Name string

Nom du groupe de documents

Récupérer tous les thèmes qui peuvent être affectés à un package

ID d’opération :
GetAllThemes

Récupère tous les thèmes qui peuvent être affectés à un package. Possible de pager le résultat en fournissant une valeur MaxQuantity et une continuationToken

Paramètres

Nom Clé Obligatoire Type Description
Jeton pour obtenir le jeu de résultats suivant
 continuationToken string

Jeton pour obtenir le jeu de résultats suivant
Quantité maximale de résultats à retourner
 maxQuantity integer

Quantité maximale de résultats à retourner
Ordre dans lequel trier les résultats
 sortOrder string

Ordre dans lequel trier les résultats
spécifier le champ à trier
 sortField string

spécifier le champ à trier

Retours

Nom Chemin d’accès Type Description
ContinuationToken
 ContinuationToken string

Jeton pour récupérer la page suivante des résultats
Objets
 Items array of object

Liste contenant les thèmes
Code
 Items.Code string

Code du thème
Nom
 Items.Name string

Nom du thème
MaxQuantity
 MaxQuantity integer

Nombre maximal de résultats retournés par requête
Total
 Total integer

Nombre total de résultats.

Récupérer toutes les langues activées dans l’application

ID d’opération :
GetAllEnabledLanguages

Récupère toutes les langues activées dans l’application

Retours

Nom Chemin d’accès Type Description
EnabledLanguages
 EnabledLanguages array of object

Liste des langues activées
DisplayName
 EnabledLanguages.DisplayName string

Nom complet de la langue
NativeName
 EnabledLanguages.NativeName string

Nom natif de la langue
IsoCultureCode
 EnabledLanguages.IsoCultureCode string

Code ISO de 2 lettres (ISO 639-1) de la langue

Supprimer le package par ID

ID d’opération :
Packages_DeleteById

Supprime un package par son ID.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package

Supprimer les parties prenantes par ID

ID d’opération :
Stakeholder_DeleteById

Supprime une partie prenantes par son ID.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package
Identificateur unique de la partie prenante
 stakeholderId True string

Identificateur unique de la partie prenante

Supprimer une étape de processus et tous ses acteurs

ID d’opération :
Process_DeleteStep

Supprime une étape de processus et tous ses acteurs.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package
Index de l’étape de processus
 stepIndex True integer

Index de l’étape de processus

Télécharger la piste d’audit du package

ID d’opération :
Packages_DownloadAuditTrail

Téléchargez une piste d’audit signée sur la durée de vie d’un package.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package
Code ISO de langue 2 (ISO 639-1)
 culture True string

Code ISO de langue 2 (ISO 639-1)

Retours

response
binary

Télécharger le document à partir du package

ID d’opération :
Documents_DownloadDocumentFromPackage

Téléchargez un document signé à partir d’un package. Chaque document sera téléchargé sous forme de fichier PDF ou XML.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package
Identificateur unique du document contenu dans le package
 documentId True string

Identificateur unique du document contenu dans le package

Retours

response
binary

Télécharger le package

ID d’opération :
Packages_DownloadPackage

Utilisé pour télécharger tous les documents d’un certain package en tant que fichier Zip.

Paramètres

Nom Clé Obligatoire Type Description
Identificateur unique du package
 packageId True string

Identificateur unique du package

Retours

response
binary

Définitions

ConfigureSigningMethod

Méthode de signature configurée dans eSignatures

Nom Chemin d’accès Type Description
IsActive
 IsActive boolean

Indique si la signatureMethod peut être utilisée pour créer des champs de signature
Nom
 Name string

Nom configuré de la méthode de signature
DisplayNames
 DisplayNames object

Nom par langue qui sera affiché à un signataire
DisplayNamesInitiator
 DisplayNamesInitiator object

Nom par langue à afficher à l’initiateur lors de la création du package.
Descriptions
 Descriptions object

Description de la méthode de signature par langue pour fournir plus d’informations sur la méthode de signature lors de la création du package.
RequiredProperties
 RequiredProperties array of string

Propriétés requises pour la signature obligatoire
KeyPairs
 KeyPairs array of KeyPair

keyPairs disponibles qui peuvent être utilisés pour signer avec cette méthode

KeyPair

représentation d’une paire de clés de signature

Nom Chemin d’accès Type Description
Nom
 Name string

Nom de la paire de clés
DisplayNames
 DisplayNames object

Nom par langue qui sera affiché à un initiateur

Common.Guid

Identificateur global unique

Identificateur global unique

string

Common.EmailAddress

Une adresse e-mail

Une adresse e-mail

email

Common.Language

Code ISO de 2 lettres d’un pays (ISO 639-1)

Code ISO de 2 lettres d’un pays (ISO 639-1)

string

Common.PhoneNumber

Un numéro de téléphone

Un numéro de téléphone

string

Common.ExternalReference

Référence externe pour le package

Référence externe pour le package

string

Common.AdditionalProperties

Propriétés supplémentaires configurables des parties prenantes

Nom Chemin d’accès Type Description
object

Propriétés supplémentaires configurables des parties prenantes

Common.DateTime

Valeur date/heure au format ISO 8601

Valeur date/heure au format ISO 8601

date-time

Package.Status

État du package

État du package

string

Package.Name

Nom du package

Nom du package

string

Document.Name

Nom du document

Nom du document

string

Document.Status

État d’un document

État d’un document

string

Document.DocumentOptions

Définit les paramètres de document facultatifs

Nom Chemin d’accès Type Description
TargetType
 TargetType string

Fonctionne uniquement lorsque le serveur est configuré pour les conversions de documents.
TargetFormat
 PdfOptions.TargetFormat string

Le format cible définit si une conversion supplémentaire doit être effectuée.
PdfErrorHandling
 PdfOptions.PdfErrorHandling string

Comment gérer les fichiers PDF contenant des défauts mineurs

Stakeholder.FirstName

Prénom de la partie prenante

Prénom de la partie prenante

string

Stakeholder.LastName

Nom de la partie prenantes

Nom de la partie prenantes

string

Actor.Type

Type d’action devant être effectué sur un package

Type d’action devant être effectué sur un package

string

Actor.Status

État d’un acteur

État d’un acteur

string

Element.Type

Type d’élément

Type d’élément

string

Element.Status

État d’un élément

État d’un élément

string

Element.Location

Nom Chemin d’accès Type Description
Page
 Page integer

Numéro de page du document
Haut
 Top number

Position supérieure en pixels
Gauche
 Left number

Position gauche en pixels

Element.Dimensions

Nom Chemin d’accès Type Description
Largeur
 Width number

Largeur de l’élément
Hauteur
 Height number

Hauteur de l’élément

Response.Package.Get

Nom Chemin d’accès Type Description
Id
 Id Common.Guid

Identificateur global unique
Nom
 Name Package.Name

Nom du package
Initiateur
 Initiator Common.EmailAddress

Une adresse e-mail
ExternalReference
 ExternalReference Common.ExternalReference

Référence externe pour le package
CreationDate
 CreationDate Common.DateTime

Valeur date/heure au format ISO 8601
Statut
 Status Package.Status

État du package
ExpireyDate
 ExpiryDate Common.DateTime

Valeur date/heure au format ISO 8601
Documents
 Documents array of Response.Document
Parties prenantes
 Stakeholders array of Response.Stakeholder

Response.Document

Nom Chemin d’accès Type Description
Id
 Id Common.Guid

Identificateur global unique
Statut
 Status Document.Status

État d’un document
DocumentOptions
 DocumentOptions Document.DocumentOptions

Définit les paramètres de document facultatifs
Nom
 Name Document.Name

Nom du document
Language
 Language Common.Language

Code ISO de 2 lettres d’un pays (ISO 639-1)
ExternalReference
 ExternalReference Common.ExternalReference

Référence externe pour le package
ProofCorrelationId
 ProofCorrelationId Common.Guid

Identificateur global unique

Response.Stakeholder

Nom Chemin d’accès Type Description
Type
 Type string

Type de partie prenante
ExternalReference
 ExternalReference Common.ExternalReference

Référence externe pour le package
Id
 Id Common.Guid

Identificateur global unique
Language
 Language Common.Language

Code ISO de 2 lettres d’un pays (ISO 639-1)
Prénom
 FirstName Stakeholder.FirstName

Prénom de la partie prenante
nom de famille
 LastName Stakeholder.LastName

Nom de la partie prenantes
Adresse e-mail
 EmailAddress Common.EmailAddress

Une adresse e-mail
Naissance
 BirthDate date
Numéro de téléphone
 PhoneNumber Common.PhoneNumber

Un numéro de téléphone
AdditionalProperties
 AdditionalProperties Common.AdditionalProperties

Propriétés supplémentaires configurables des parties prenantes
Acteurs
 Actors array of Response.Actor

Response.Actor

Nom Chemin d’accès Type Description
Type
 Type Actor.Type

Type d’action devant être effectué sur un package
Id
 Id Common.Guid

Identificateur global unique
Id de partie prenante
 StakeholderId Common.Guid

Identificateur global unique
Statut
 Status Actor.Status

État d’un acteur
SuppressNotifications
 SuppressNotifications boolean

Supprimer les notifications pour l’acteur
RedirectUrl
 RedirectUrl url

URL de redirection une fois l’action de l’acteur terminée
Elements
 Elements array of Response.Element

Response.Element

Nom Chemin d’accès Type Description
Type
 Type Element.Type

Type d’élément
Id
 Id Common.Guid

Identificateur global unique
ActorId
 ActorId Common.Guid

Identificateur global unique
DocumentId
 DocumentId integer

Identificateur du document dans le package
Statut
 Status Element.Status

État d’un élément
ExternalReference
 ExternalReference Common.ExternalReference

Référence externe pour le package
Emplacement
 Location Element.Location
Taille
 Dimensions Element.Dimensions
SigningMethods
 SigningMethods array of string
UsedSigningMethod
 UsedSigningMethod string

Méthode de signature utilisée

Response.Package.Status

Nom Chemin d’accès Type Description
Statut
 Status Package.Status

État du package

binaire

Il s’agit du type de données de base « binary ».