Signe Nitro (préversion)

L’API Nitro Sign permet de sécuriser les flux de travail eSignature de bout en bout en permettant aux applications de créer, de gérer et de suivre les processus de signature numérique. Il fournit des fonctionnalités permettant de créer des enveloppes, de charger des documents, d’ajouter des participants, de définir un ordre de signature et d’envoyer des documents pour la signature via une approche entièrement automatisée basée sur l’API.

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 Standard Toutes les régions Logic Apps , à l’exception des suivantes :
     - régions Azure Government
     - régions de chine Azure
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps à l’exception des éléments suivants :
     - 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
Email prosupport@sfdc.gonitro.com
Métadonnées du connecteur
Éditeur Nitro PDF
Website https://www.gonitro.com/
Politique de confidentialité https://www.gonitro.com/legal/privacy-policy
Catégories Productivité; Opérations informatiques

Connecteur de signe Nitro

Aperçu

Le connecteur Nitro Sign permet de sécuriser les flux de travail eSignature de bout en bout directement à partir de Power Automate et de Power Apps. Il permet aux applications de créer et de gérer des enveloppes de signature, de charger et de réorganiser des documents, d’ajouter des participants et de définir l’ordre de signature, de placer la signature et des champs de données, d’envoyer des documents à des fins de signature, de suivre la progression et de télécharger les fichiers originaux, scellés et de piste d’audit, tout au long d’une approche entièrement automatisée basée sur les API.

Publisher : Nitro Software

Prerequisites

Pour utiliser Nitro Sign via ce connecteur, vous aurez besoin des éléments suivants :

  • Un compte Nitro avec Nitro Sign activé
    https://developers.gonitro.com/
  • Un plan Microsoft PowerApps ou Power Automate avec des fonctionnalités de connecteur personnalisé.

Authentication

Nitro Sign utilise OAuth 2.0 machine à machine avec l’octroi d’informations d’identification du client pour générer des jetons d’accès pour les demandes d’API.

Fonctionnement

  • Vous créez une application API dans le portail libre-service de Nitro et obtenez l’ID client associé et la clé secrète client.
  • Le connecteur s’authentifie en échangeant ces informations d’identification pour un jeton d’accès du porteur .
  • Le jeton est ensuite utilisé pour autoriser les appels d’API Nitro Sign suivants.

Créez des informations d’identification et lisez le guide détaillé :
https://developers.gonitro.com/docs/authentication/credentials

Création d’une connexion dans Power Automate/Power Apps

Lors de l’ajout du connecteur à un flux ou une application :

  1. Cliquez sur Ajouter une nouvelle connexion.
  2. Entrez votre ID client et votre clé secrète client (émis dans le portail des développeurs Nitro).
  3. Sélectionnez votre région Nitro (Europe, États-Unis ou APAC) : région associée à votre compte Nitro.
  4. Enregistrez la connexion : lors de la première utilisation, le connecteur échange votre ID client et votre clé secrète client pour un jeton d’accès à courte durée à l’aide de l’octroi des informations d’identification du client OAuth 2.0, le met en cache et le renouvelle automatiquement. Vos informations d’identification sont utilisées uniquement pour obtenir le jeton ; les appels d’API suivants sont authentifiés avec un jeton du porteur en votre nom.

Remarque : Aucune connexion interactive de l’utilisateur n’est requise ; ce flux est conçu pour les scénarios serveur à serveur/application à application.

Opérations prises en charge

Le connecteur regroupe ses actions autour des quatre ressources d’un flux de travail de signature ( enveloppes, documents, champs et participants ), ainsi qu’un ensemble d’actions de téléchargement pour récupérer les fichiers terminés.

1. Enveloppes

Une enveloppe est le conteneur des documents, des participants et des champs dans une seule demande de signature.

  • Répertorier les enveloppes
    Retourne toutes les enveloppes associées à l’application dans le compte. Les résultats sont paginés : la réponse inclut un jeton de curseur Page suivante , que vous pouvez fournir au paramètre Page After facultatif pour récupérer la page suivante (ou Page Avant de page vers l’arrière). Les deux paramètres de curseur sont sous Avancé et sont uniquement nécessaires lors de la marche à pas dans les jeux de résultats volumineux.

  • Créer une enveloppe
    Crée une enveloppe avec un nom, un message de notification (objet + corps, avec des variables dynamiques telles que $(sender_name_or_email) et $(envelope_name)) et le mode de signature :

    • parallel — tous les participants sont avertis en même temps et peuvent signer indépendamment.
    • sequential — les participants sont avertis un par un, dans l’ordre dans lequel ils ont été ajoutés.

  • Obtenir l’enveloppe par ID
    Récupère les détails d’une enveloppe spécifique par son UUID.

  • Mettre à jour l’enveloppe
    Met à jour le nom de l’enveloppe, les paramètres de notification et/ou le mode de signature. Tous les champs sont facultatifs.

  • Supprimer l’enveloppe par ID
    Supprime définitivement une enveloppe et tous les documents, champs et participants associés. Cela ne peut pas être annulé.

  • Enveloppe d’envoi pour la signature
    Envoie l’enveloppe aux participants pour la collection de signatures. Avant d’envoyer, l’enveloppe doit normalement avoir ses documents, participants et champs de signature ajoutés (via Create Document by Envelope ID, Create Participant(s) by Envelope ID et Create Field(s) by Document ID(s) by Document ID). Tous les documents de l’enveloppe doivent avoir un état chargé avant que l’enveloppe puisse être envoyée.

  • Envoyer des rappels pour l’enveloppe
    Déclenche des notifications de rappel aux participants en attente. Si aucun paramètre de notification n’est fourni, le modèle de notification par défaut configuré pour l’enveloppe est utilisé.

  • Annuler l’enveloppe par ID
    Annule la demande de signature. Seules les enveloppes qui ont déjà été envoyées pour la signature peuvent être annulées.

2. Documents

Les documents sont les fichiers attachés à une enveloppe et signés par les participants.

  • Répertorier les documents par ID d’enveloppe
    Récupère tous les documents associés à une enveloppe.

  • Créer un document par ID d’enveloppe
    Charge un document dans une enveloppe existante. Fournissez le fichier plus des champs simples et typés , sans JSON écrit manuellement :

    • Fichier de document : fichier à charger.
    • Nom du document : nom sous lequel stocker le document.
    • Type de contenu(avancé, facultatif) : type MIME du fichier ; est défini par défaut sur application/pdf. En cas d’omission, seuls les fichiers PDF sont acceptés.

  • Obtenir un document par ID
    Récupère les détails d’un document spécifique dans une enveloppe.

  • Mettre à jour le document par ID
    Met à jour les métadonnées de document. Actuellement, seul le nom du document peut être modifié.

  • Supprimer le document par ID
    Supprime définitivement un document d’une enveloppe.

  • Réorganiser des documents par ID d’enveloppe
    Réorganise les documents dans une enveloppe en fonction d’une liste fournie d’ID de document.

3. Champs

Les champs sont les éléments interactifs (signature, initiales, date, etc.) placés sur un document et affectés à un participant.

  • Répertorier les champs par ID de document
    Récupère tous les champs associés à un document spécifique.

  • Créer des champs par ID de document
    Crée un ou plusieurs champs sur un document et les affecte aux participants. Fournissez un élément pour un seul champ ou plusieurs éléments pour une requête en bloc. Chaque champ spécifie :

    • participantID — participant affecté au champ.
    • type— un de signature, , nameinitials, datecheckboxtitlecompany, . custom
    • page — numéro de page (indexation basée sur 1).
    • Position X, Position Y, Largeur, Hauteur : la position et la taille du champ, chacune entrée sous la forme d’un nombre distinct en points (X/Y sont mesurées à partir du bord gauche/supérieur de la page). Celles-ci remplacent le tableau unique boundingBox précédent, de sorte que chaque valeur est un champ typé dans l’interface utilisateur plutôt qu’une liste intégrée à la main.
    • Facultatif : required (valeur par défaut true) et , sous Avancéformat (par exemple MM/DD/YYYY , pour les champs de date) et modifiable.

  • Mettre à jour le champ par ID
    Met à jour les propriétés d’un champ existant. Le champ type doit être fourni et doit correspondre au type de champ existant : il est utilisé pour identifier le schéma de champ et ne modifie pas le type de champ.

  • Supprimer le champ par ID
    Supprime définitivement un champ d’un document.

4. Participants

Les participants sont les personnes qui reçoivent l’enveloppe , soit pour la signer, soit pour être informées.

  • Répertorier les participants par ID d’enveloppe
    Récupère tous les participants associés à une enveloppe.

  • Créer un ou plusieurs participants par ID d’enveloppe
    Ajoute un ou plusieurs participants à une enveloppe. Fournissez un élément pour un seul participant ou plusieurs éléments pour une demande en bloc. Chaque participant spécifie :

    • email — adresse e-mail du participant.
    • role — signer (peut avoir des champs affectés pour la signature) ou cc (accès en lecture seule).
    • authentication (avancé, facultatif) :code d’accès actuellement : code d’accès statique que le participant doit fournir avant la signature. Ouvrez cette section uniquement si le participant doit s’authentifier avant la signature.

  • Mettre à jour le participant par ID
    Met à jour les paramètres d’authentification d’un participant. Impossible de modifier l’e-mail du participant.

  • Supprimer le participant par ID
    Supprime définitivement un participant d’une enveloppe.

5. Téléchargements

Récupérez les fichiers terminés une fois que les documents ont été signés et scellés.

  • Télécharger l’enveloppe d’origine
    Télécharge les documents non signés d’origine à partir d’une enveloppe en tant qu’archive ZIP .

  • Télécharger l’enveloppe scellée
    Télécharge les documents signés scellés, ainsi que la piste d’audit, en tant qu’archive ZIP .

  • Télécharger le document scellé par ID
    Télécharge un document signé unique sous forme de fichier PDF .

  • Télécharger la piste d’audit de l’enveloppe
    Télécharge la piste d’audit complète d’une enveloppe sous forme de fichier PDF .

Les actions de téléchargement exposent le nom de fichier natif du sélecteur et les jetons de contenu de fichier (plus le type de contenu de fichier). Supprimez le contenu du fichier directement dans l’entrée de fichier d’une étape en aval ( par exemple, OneDrive / SharePoint Créer un fichier ) et nom de fichier dans son entrée de nom de fichier. Aucune body('Action_Name') expression ou nom de fichier typé manuellement n’est nécessaire ; le connecteur encapsule le fichier ZIP ou PDF téléchargé dans une enveloppe JSON afin que Power Automate les expose comme des jetons de contenu dynamique ordinaires.

Workflow de signature classique

Un flux de signature complet chaîne les actions ci-dessus dans l’ordre. Un flux Power Automate courant ressemble à ceci :

  1. Créer une enveloppe : définissez le nom, l’objet/le corps de notification et le mode de signature (parallel ou sequential). Enregistrez l’ID d’enveloppe retourné.
  2. Créer un document par ID d’enveloppe : chargez un ou plusieurs fichiers dans l’enveloppe (à l’aide de l’ID d’enveloppe de l’étape 1). Enregistrez chaque ID de document retourné.
    (Facultatif)Réorganiser les documents par ID d’enveloppe : définissez l’ordre des documents.
  3. Créez le ou les participants par ID d’enveloppe : ajoutez les signataires et les destinataires CC, avec leur authentification par code d’accès. Enregistrez chaque ID de participant retourné.
  4. Créez des champs par ID de document : placez les champs signature/date/etc. sur chaque document et affectez-les aux participants (à l’aide de l’ID de document de l’étape 2 et de l’ID de participant de l’étape 3).
  5. Envoyer l’enveloppe pour la signature : distribuez l’enveloppe. Tous les documents doivent d’abord être dans l’état chargé.
  6. (En attente)Envoyez des rappels pour l’enveloppe afin de déplacer les participants, ou annulez l’enveloppe par ID pour arrêter la demande.
  7. (Une fois terminé)Télécharger l’enveloppe scelléeTélécharger le document scellé par ID / télécharger la piste d’audit de l’enveloppe / pour récupérer les fichiers terminés.

Conseil : L'ID d'enveloppe, l'ID de document et l'ID de participant retournés par les actions de création sont naturellement acheminés vers les actions ultérieures via le sélecteur de contenu dynamique de Power Automate , choisissez le jeton d'ID à partir de l'action en amont plutôt que de le taper.

Erreurs & Limitation

L’API Nitro Sign peut retourner les erreurs suivantes :

  • 400 — Demande incorrecte
  • 401 — Non autorisé
  • 404 — Introuvable
  • 409 — Conflit (par exemple, agissant sur une enveloppe dans un état qui n’autorise pas l’opération)
  • 413 — Contenu trop volumineux
  • 415 — Type de média non pris en charge
  • 422 — Entité non traité
  • 500 — Erreur de serveur interne

Limitation

  • Appels d’API par connexion : 100 par 60 secondes.

Limites de plateforme

Taille de fichier

  • Maximum : 25 Mo par requête
    S’applique aux opérations à fichier unique et à plusieurs fichiers.

Nombre de pages

  • Maximum : 250 pages par document individuel
    Le nombre total de pages combinées sur plusieurs documents peut dépasser 250.

Durée de rétention

  • Les fichiers d’entrée et de sortie sont supprimés environ 15 minutes après la fin de l’opération.

Notes

  • Les actions de gestion d’enveloppe, de document, de champ et de participant retournent JSON.
  • Les actions de téléchargement retournent le fichier (ZIP ou PDF) encapsulé dans une enveloppe JSON exposant le nom de fichier, le type de contenu de fichier et le contenu de fichier en tant que jetons natifs du sélecteur, afin que les résultats puissent être chaînés dans une action de fichier en aval sans expressions.
  • Le mode de signature (parallel vs sequential) est défini lorsque l’enveloppe est créée et peut être modifiée avec l’enveloppe de mise à jour avant l’envoi de l’enveloppe.
  • L’authentification des participants prend actuellement uniquement en charge le code d’accès .

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 Catégorie Description Obligatoire
Nitro Client ID securestring ID client de votre application Nitro True
Nitro Client Secret securestring Secret client de votre application Nitro True
Région Nitro string Sélectionnez la région de l’API Nitro pour votre compte. True

Actions

Annuler l’enveloppe par ID

Annule la demande de signature d’une enveloppe de signe Nitro. Seules les enveloppes envoyées pour signature peuvent être annulées.
Créer des champs par ID de document

Crée un ou plusieurs champs sur un document et les affecte aux participants. Pour créer un champ unique, fournissez un élément dans le tableau Champs. Pour créer plusieurs champs, fournissez plusieurs éléments.
Créer un document par ID d’enveloppe

Charge un document dans une enveloppe de signe Nitro existante. Le document peut être utilisé ultérieurement dans le flux de travail de signature.
Créer un ou plusieurs participants par ID d’enveloppe

Ajoute un ou plusieurs participants à une enveloppe de signe Nitro. Pour ajouter un seul participant, fournissez un élément dans le tableau Participants. Pour ajouter plusieurs participants, fournissez plusieurs éléments.
Créer une enveloppe

Crée une enveloppe de signe Nitro qui peut être renseignée ultérieurement avec des documents, des participants, des champs et envoyée pour la signature.
Enveloppe d’envoi pour la signature

Envoie une enveloppe Nitro Sign aux participants pour la collection de signatures. Avant d’utiliser cette action, l’enveloppe doit normalement comporter des documents, des participants et des champs de signature ajoutés à l’aide de l’ID créer un document par ID d’enveloppe, créer un ou plusieurs participants par ID d’enveloppe et créer des champs par ID de document. Tous les documents de l’enveloppe doivent avoir un état chargé avant que l’enveloppe puisse être envoyée.
Envoyer des rappels pour l’enveloppe

Déclenche des notifications de rappel aux participants en attente d’une enveloppe de signe Nitro spécifiée. Si aucun paramètre de notification n’est fourni, le modèle de notification par défaut configuré pour l’enveloppe est utilisé.
Mettre à jour le champ par ID

Met à jour les propriétés d’un champ existant dans un document Nitro Sign. Le type de champ doit être fourni et doit correspondre au type de champ existant ; il est utilisé par l’API pour identifier le schéma de champ et ne modifie pas le type de champ.
Mettre à jour le document par ID

Met à jour les métadonnées d’un document existant dans une enveloppe de signe Nitro. Actuellement, seul le nom du document peut être mis à jour.
Mettre à jour le participant par ID

Met à jour les paramètres d’authentification d’un participant dans une enveloppe de signe Nitro. Impossible de mettre à jour l’e-mail du participant.
Mettre à jour l’enveloppe

Met à jour une enveloppe de signe Nitro existante. Vous pouvez modifier le nom de l’enveloppe, les paramètres de notification, le mode de signature ou toute combinaison de ces champs.
Obtenir l’enveloppe par ID

Récupère les détails d’une enveloppe Nitro Sign spécifique à l’aide de son ID d’enveloppe unique.
Obtenir un document par ID

Récupère les détails d’un document spécifique dans une enveloppe de signe Nitro.
Réorganiser des documents par ID d’enveloppe

Réorganise les documents associés à une enveloppe Nitro Sign spécifique en fonction de la liste fournie des ID de document.
Répertorier les champs par ID de document

Récupère tous les champs associés à un document spécifique dans une enveloppe de signe Nitro.
Répertorier les documents par ID d’enveloppe

Récupère tous les documents associés à une enveloppe de signe Nitro spécifique.
Répertorier les enveloppes

Le point de terminaison List Envelopes retourne toutes les enveloppes associées à une application dans un compte.
Répertorier les participants par ID d’enveloppe

Récupère tous les participants associés à une enveloppe de signe Nitro spécifique.
Supprimer le champ par ID

Supprime définitivement un champ d’un document dans une enveloppe de signe Nitro.
Supprimer le document par ID

Supprime définitivement un document d’une enveloppe de signe Nitro.
Supprimer le participant par ID

Supprime définitivement un participant d’une enveloppe de signe Nitro.
Supprimer l’enveloppe par ID

Supprime définitivement une enveloppe de signe Nitro. Cette opération ne peut pas être annulée et tous les documents, champs et participants associés sont également supprimés.
Télécharger la piste d’audit de l’enveloppe

Télécharge le fichier PDF contenant la piste d’audit complète de l’enveloppe de signe Nitro sélectionnée.
Télécharger le document scellé par ID

Télécharge un document signé unique à partir d’une enveloppe Nitro Sign sous forme de fichier PDF.
Télécharger l’enveloppe d’origine

Télécharge les documents non signés d’origine à partir d’une enveloppe Nitro Sign en tant qu’archive ZIP.
Télécharger l’enveloppe scellée

Télécharge les documents signés scellés à partir d’une enveloppe de signe Nitro, ainsi que la piste d’audit, en tant qu’archive ZIP.

Annuler l’enveloppe par ID

ID d’opération :
CancelEnvelopeByID

Annule la demande de signature d’une enveloppe de signe Nitro. Seules les enveloppes envoyées pour signature peuvent être annulées.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

UUID unique qui identifie l’enveloppe à annuler.

Retours

Réponse retournée après la demande ou la création d’une enveloppe de signe Nitro.

Corps
EnvelopeResponse

Créer des champs par ID de document

ID d’opération :
CreateFieldsByDocumentID

Crée un ou plusieurs champs sur un document et les affecte aux participants. Pour créer un champ unique, fournissez un élément dans le tableau Champs. Pour créer plusieurs champs, fournissez plusieurs éléments.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

Un UUID unique qui identifie l’enveloppe.
ID du document
 documentID True uuid

Un UUID unique qui identifie le document où les champs doivent être créés.
Identifiant du participant
 participantID True uuid

Identificateur unique du participant affecté au champ.
Page
 page True integer

Numéro de page où le champ doit être placé. Les pages utilisent l’indexation basée sur 1. La première page est donc 1.
Type de champ
 type True string

Type de champ à créer.
X Position
 x True float

Position horizontale du champ, mesurée à partir du bord gauche de la page en points.
Y Position
 y True float

Position verticale du champ, mesurée à partir du bord supérieur de la page en points.
Largeur
 width True float

Largeur du champ en points.
Hauteur
 height True float

Hauteur du champ en points.
Obligatoire
 required boolean

Indique si le participant doit effectuer ce champ.
Format
 format string

Format facultatif pour les types de champs qui prennent en charge la mise en forme, par exemple les champs de date. Exemple : MM/DD/AAAA.
Modifiable
 modifiable boolean

Indique si la valeur du champ peut être modifiée par le participant, où elle est prise en charge par le type de champ.

Retours

Réponse retournée après avoir créé un ou plusieurs champs.

Corps
FieldsResponse

Créer un document par ID d’enveloppe

ID d’opération :
CreateDocumentByEnvelopeID

Charge un document dans une enveloppe de signe Nitro existante. Le document peut être utilisé ultérieurement dans le flux de travail de signature.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

Un UUID unique qui identifie l’enveloppe dans laquelle le document sera chargé.
Nom du document
 documentName True string

Nom du document à charger. Cette valeur sera utilisée pour générer les métadonnées de document envoyées à Nitro.
Type de contenu
 contentType string

Type de contenu du document chargé. Pour les fichiers PDF, utilisez application/pdf. Lorsqu’il est omis des métadonnées, seuls les fichiers PDF sont acceptés.
Fichier de document
 payload True file

Fichier de document à charger dans l’enveloppe.

Retours

Nom Chemin d’accès Type Description
ID du document
 ID uuid

Un UUID unique qui identifie le document chargé.
Nom du document
 name string

Nom du document chargé.
Créé à
 createdAt string

Horodatage indiquant quand le document a été créé.
État du document
 status string

État de traitement du document chargé.

Créer un ou plusieurs participants par ID d’enveloppe

ID d’opération :
CreateParticipantsByEnvelopeID

Ajoute un ou plusieurs participants à une enveloppe de signe Nitro. Pour ajouter un seul participant, fournissez un élément dans le tableau Participants. Pour ajouter plusieurs participants, fournissez plusieurs éléments.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

Un UUID unique qui identifie l’enveloppe dans laquelle les participants doivent être ajoutés.
Email
 email True email

Adresse e-mail du participant.
Role
 role True string

Rôle de participant. Un signataire peut avoir des champs attribués pour la signature. Un participant cc dispose d’un accès en lecture seule.
Type d’authentification
 type string

Optional. Sélectionnez une méthode d’authentification pour le participant. Si spécifié, un code d’accès doit également être fourni.
Code d'accès
 accessCode string

Obligatoire uniquement lorsque le type d’authentification est spécifié. Laissez vide si l’authentification des participants n’est pas nécessaire.

Retours

Réponse retournée après avoir créé un ou plusieurs participants.

Corps
ParticipantsResponse

Créer une enveloppe

ID d’opération :
CreateEnvelope

Crée une enveloppe de signe Nitro qui peut être renseignée ultérieurement avec des documents, des participants, des champs et envoyée pour la signature.

Paramètres

Nom Clé Obligatoire Type Description
Nom de l’enveloppe
 name True string

Nom de l’enveloppe. Il n'est pas nécessaire qu'elle soit unique.
Mode de signature
 mode True string

Définit l’ordre de signature. Utilisez parallèlement pour avertir tous les participants en même temps, ou séquentielles pour avertir les participants un par un dans l’ordre dans lequel ils ont été ajoutés.
Objet de notification
 subject True string

Ligne d’objet de la notification par e-mail envoyée aux participants de signature. Les variables dynamiques sont prises en charge, par exemple : $(sender_name_or_email) demande votre signature.
Corps de la notification
 body True string

Corps de l’e-mail envoyé aux participants de signature. Les variables dynamiques sont prises en charge, par exemple : Bonjour,\nVeuillez signer le\n$(envelope_name)\n$(sender_name_or_email).

Retours

Réponse retournée après la demande ou la création d’une enveloppe de signe Nitro.

Corps
EnvelopeResponse

Enveloppe d’envoi pour la signature

ID d’opération :
SendEnvelopeForSigning

Envoie une enveloppe Nitro Sign aux participants pour la collection de signatures. Avant d’utiliser cette action, l’enveloppe doit normalement comporter des documents, des participants et des champs de signature ajoutés à l’aide de l’ID créer un document par ID d’enveloppe, créer un ou plusieurs participants par ID d’enveloppe et créer des champs par ID de document. Tous les documents de l’enveloppe doivent avoir un état chargé avant que l’enveloppe puisse être envoyée.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

Un UUID unique qui identifie l’enveloppe à envoyer pour la signature.

Retours

Informations récapitulatives sur une enveloppe de signe Nitro.

Corps
EnvelopeSummaryResponse

Envoyer des rappels pour l’enveloppe

ID d’opération :
SendRemindersForEnvelope

Déclenche des notifications de rappel aux participants en attente d’une enveloppe de signe Nitro spécifiée. Si aucun paramètre de notification n’est fourni, le modèle de notification par défaut configuré pour l’enveloppe est utilisé.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

Un UUID unique qui identifie l’enveloppe pour laquelle les notifications de rappel doivent être envoyées.
Objet de notification
 subject string

Ligne d’objet de la notification par e-mail envoyée aux participants de signature. Les variables dynamiques sont prises en charge, par exemple : $(sender_name_or_email) demande votre signature.
Corps de la notification
 body string

Corps de l’e-mail envoyé aux participants de signature. Les variables dynamiques sont prises en charge, par exemple : Bonjour,\nVeuillez signer le\n$(envelope_name)\n$(sender_name_or_email).

Mettre à jour le champ par ID

ID d’opération :
UpdateFieldByID

Met à jour les propriétés d’un champ existant dans un document Nitro Sign. Le type de champ doit être fourni et doit correspondre au type de champ existant ; il est utilisé par l’API pour identifier le schéma de champ et ne modifie pas le type de champ.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

UUID unique qui identifie l’enveloppe contenant le document.
ID du document
 documentID True uuid

Un UUID unique qui identifie le document contenant le champ.
Identifiant du champ
 fieldID True uuid

Un UUID unique qui identifie le champ à mettre à jour.
Type de champ
 type True string

Type actuel du champ mis à jour. Cette valeur est requise par l’API et doit correspondre au type de champ existant ; il ne modifie pas le type de champ.
Identifiant du participant
 participantID uuid

Identificateur unique du participant affecté au champ.
Page
 page integer

Numéro de page dans lequel le champ s’affiche. Les pages utilisent l’indexation basée sur 1.
X Position
 x float

Optional. Position horizontale du champ, mesurée à partir du bord gauche de la page en points.
Y Position
 y float

Optional. Position verticale du champ, mesurée à partir du bord supérieur de la page en points.
Largeur
 width float

Optional. Largeur du champ en points.
Hauteur
 height float

Optional. Hauteur du champ en points.
Obligatoire
 required boolean

Indique si le participant doit effectuer ce champ.
Format
 format string

Format de champ, le cas échéant. Par exemple, les champs de date peuvent utiliser un format tel que MM/DD/AAAA.
Modifiable
 modifiable boolean

Indique si la valeur du champ est modifiable, le cas échéant.

Retours

Détails du champ Nitro Sign.

Corps
FieldResponse

Mettre à jour le document par ID

ID d’opération :
UpdateDocumentByID

Met à jour les métadonnées d’un document existant dans une enveloppe de signe Nitro. Actuellement, seul le nom du document peut être mis à jour.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

UUID unique qui identifie l’enveloppe contenant le document.
ID du document
 documentID True uuid

UUID unique qui identifie le document à mettre à jour.
Nom du document
 name True string

Nouveau nom du document.

Retours

Détails du document Nitro Sign.

Corps
DocumentResponse

Mettre à jour le participant par ID

ID d’opération :
UpdateParticipantByID

Met à jour les paramètres d’authentification d’un participant dans une enveloppe de signe Nitro. Impossible de mettre à jour l’e-mail du participant.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

Un UUID unique qui identifie l’enveloppe contenant le participant.
Identifiant du participant
 participantID True uuid

Un UUID unique qui identifie le participant à mettre à jour.
Type d’authentification
 type string

Optional. Sélectionnez une méthode d’authentification pour le participant. Si spécifié, un code d’accès doit également être fourni.
Code d'accès
 accessCode string

Obligatoire uniquement lorsque le type d’authentification est spécifié. Laissez vide si l’authentification des participants n’est pas nécessaire.

Retours

Détails du participant Nitro Sign.

Corps
ParticipantResponse

Mettre à jour l’enveloppe

ID d’opération :
UpdateEnvelope

Met à jour une enveloppe de signe Nitro existante. Vous pouvez modifier le nom de l’enveloppe, les paramètres de notification, le mode de signature ou toute combinaison de ces champs.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

Un UUID unique qui identifie l’enveloppe à mettre à jour.
Nom de l’enveloppe
 name string

Nom de l’enveloppe mise à jour. Il n'est pas nécessaire qu'elle soit unique.
Objet de notification
 subject string

Ligne d’objet de la notification par e-mail envoyée aux participants de signature. Les variables dynamiques sont prises en charge, par exemple : $(sender_name_or_email) demande votre signature.
Corps de la notification
 body string

Corps de l’e-mail envoyé aux participants de signature. Les variables dynamiques sont prises en charge, par exemple : Bonjour,\nVeuillez signer le\n$(envelope_name)\n$(sender_name_or_email).
Mode de signature
 mode string

Définit l’ordre de signature. Utilisez parallèlement pour avertir tous les participants en même temps, ou séquentielles pour avertir les participants un par un dans l’ordre dans lequel ils ont été ajoutés.

Retours

Réponse retournée après la demande ou la création d’une enveloppe de signe Nitro.

Corps
EnvelopeResponse

Obtenir l’enveloppe par ID

ID d’opération :
GetEnvelopeByID

Récupère les détails d’une enveloppe Nitro Sign spécifique à l’aide de son ID d’enveloppe unique.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

UUID unique qui identifie l’enveloppe à récupérer.

Retours

Réponse retournée après la demande ou la création d’une enveloppe de signe Nitro.

Corps
EnvelopeResponse

Obtenir un document par ID

ID d’opération :
GetDocumentByID

Récupère les détails d’un document spécifique dans une enveloppe de signe Nitro.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

UUID unique qui identifie l’enveloppe contenant le document.
ID du document
 documentID True uuid

Un UUID unique qui identifie le document à récupérer.

Retours

Détails du document Nitro Sign.

Corps
DocumentResponse

Réorganiser des documents par ID d’enveloppe

ID d’opération :
ReorderDocumentsByEnvelopeID

Réorganise les documents associés à une enveloppe Nitro Sign spécifique en fonction de la liste fournie des ID de document.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

UUID unique qui identifie l’enveloppe dont les documents doivent être réorganisé.
ID de document
 order True array of uuid

Tableau d’ID de document représentant le nouvel ordre des documents dans l’enveloppe.

Retours

Réponse retournée lors de la liste des documents associés à une enveloppe de signe Nitro.

Corps
ListDocumentsByEnvelopeIDResponse

Répertorier les champs par ID de document

ID d’opération :
ListFieldsByDocumentID

Récupère tous les champs associés à un document spécifique dans une enveloppe de signe Nitro.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

UUID unique qui identifie l’enveloppe contenant le document.
ID du document
 documentID True uuid

UUID unique qui identifie le document dont les champs doivent être récupérés.

Retours

Réponse retournée après avoir créé un ou plusieurs champs.

Corps
FieldsResponse

Répertorier les documents par ID d’enveloppe

ID d’opération :
ListDocumentsByEnvelopeID

Récupère tous les documents associés à une enveloppe de signe Nitro spécifique.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

Un UUID unique qui identifie l’enveloppe dont les documents doivent être récupérés.

Retours

Réponse retournée lors de la liste des documents associés à une enveloppe de signe Nitro.

Corps
ListDocumentsByEnvelopeIDResponse

Répertorier les enveloppes

ID d’opération :
ListEnvelopes

Le point de terminaison List Envelopes retourne toutes les enveloppes associées à une application dans un compte.

Paramètres

Nom Clé Obligatoire Type Description
Page après
 pageAfter string

Jeton de curseur facultatif utilisé pour récupérer la page suivante des enveloppes. Utilisez la valeur nextPage retournée par la réponse précédente.
Page avant
 pageBefore string

Jeton de curseur facultatif utilisé pour récupérer la page précédente des enveloppes. Ne pas utiliser avec Page After.

Retours

Nom Chemin d’accès Type Description
Enveloppes
 items array of EnvelopeSummaryResponse

Liste des enveloppes.
Page suivante
 nextPage string

Jeton de curseur qui peut être utilisé comme Page After pour récupérer la page suivante des enveloppes.

Répertorier les participants par ID d’enveloppe

ID d’opération :
ListParticipantsByEnvelopeID

Récupère tous les participants associés à une enveloppe de signe Nitro spécifique.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

Un UUID unique qui identifie l’enveloppe dont les participants doivent être récupérés.

Retours

Réponse retournée lors de la liste des participants associés à une enveloppe de signe Nitro.

Corps
ParticipantsListResponse

Supprimer le champ par ID

ID d’opération :
DeleteFieldByID

Supprime définitivement un champ d’un document dans une enveloppe de signe Nitro.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

UUID unique qui identifie l’enveloppe contenant le document.
ID du document
 documentID True uuid

Un UUID unique qui identifie le document contenant le champ.
Identifiant du champ
 fieldID True uuid

UUID unique qui identifie le champ à supprimer.

Supprimer le document par ID

ID d’opération :
DeleteDocumentByID

Supprime définitivement un document d’une enveloppe de signe Nitro.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

UUID unique qui identifie l’enveloppe contenant le document.
ID du document
 documentID True uuid

Un UUID unique qui identifie le document à supprimer.

Supprimer le participant par ID

ID d’opération :
DeleteParticipantByID

Supprime définitivement un participant d’une enveloppe de signe Nitro.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

Un UUID unique qui identifie l’enveloppe contenant le participant.
Identifiant du participant
 participantID True uuid

Un UUID unique qui identifie le participant à supprimer.

Supprimer l’enveloppe par ID

ID d’opération :
DeleteEnvelopeByID

Supprime définitivement une enveloppe de signe Nitro. Cette opération ne peut pas être annulée et tous les documents, champs et participants associés sont également supprimés.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

UUID unique qui identifie l’enveloppe à supprimer.

Télécharger la piste d’audit de l’enveloppe

ID d’opération :
DownloadAuditTrailOfEnvelope

Télécharge le fichier PDF contenant la piste d’audit complète de l’enveloppe de signe Nitro sélectionnée.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

Un UUID unique qui identifie l’enveloppe dont la piste d’audit doit être téléchargée.

Retours

Fichier téléchargé encapsulé sous forme d’enveloppe JSON.

Corps
FileDownloadResponse

Télécharger le document scellé par ID

ID d’opération :
DownloadSealedDocumentByID

Télécharge un document signé unique à partir d’une enveloppe Nitro Sign sous forme de fichier PDF.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

Un UUID unique qui identifie l’enveloppe contenant le document scellé.
ID du document
 documentID True uuid

Un UUID unique qui identifie le document scellé à télécharger.

Retours

Fichier téléchargé encapsulé sous forme d’enveloppe JSON.

Corps
FileDownloadResponse

Télécharger l’enveloppe d’origine

ID d’opération :
DownloadOriginalEnvelope

Télécharge les documents non signés d’origine à partir d’une enveloppe Nitro Sign en tant qu’archive ZIP.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

Un UUID unique qui identifie l’enveloppe dont les documents d’origine doivent être téléchargés.

Retours

Fichier téléchargé encapsulé sous forme d’enveloppe JSON.

Corps
FileDownloadResponse

Télécharger l’enveloppe scellée

ID d’opération :
DownloadSealedEnvelope

Télécharge les documents signés scellés à partir d’une enveloppe de signe Nitro, ainsi que la piste d’audit, en tant qu’archive ZIP.

Paramètres

Nom Clé Obligatoire Type Description
ID d’enveloppe
 envelopeID True uuid

Un UUID unique qui identifie l’enveloppe dont les documents scellés doivent être téléchargés.

Retours

Fichier téléchargé encapsulé sous forme d’enveloppe JSON.

Corps
FileDownloadResponse

Définitions

EnvelopeNotification

Paramètres d’e-mail de notification pour une enveloppe de signe Nitro.

Nom Chemin d’accès Type Description
Objet de notification
 subject string

Ligne d’objet de la notification par e-mail envoyée aux participants de signature. Les variables dynamiques sont prises en charge, par exemple : $(sender_name_or_email) demande votre signature.
Corps de la notification
 body string

Corps de l’e-mail envoyé aux participants de signature. Les variables dynamiques sont prises en charge, par exemple : Bonjour,\nVeuillez signer le\n$(envelope_name)\n$(sender_name_or_email).

EnvelopeSummaryResponse

Informations récapitulatives sur une enveloppe de signe Nitro.

Nom Chemin d’accès Type Description
ID d’enveloppe
 ID uuid

Un UUID unique qui identifie l’enveloppe.
Créé à
 createdAt date-time

Horodatage UTC indiquant quand l’enveloppe a été créée.
Dernière modification à
 lastModifiedAt date-time

Horodatage UTC indiquant quand l’enveloppe a été modifiée pour la dernière fois.
Nom de l’enveloppe
 name string

Nom de l’enveloppe.
État de l’enveloppe
 status string

État interne de l’enveloppe.

EnvelopeResponse

Réponse retournée après la demande ou la création d’une enveloppe de signe Nitro.

Nom Chemin d’accès Type Description
ID d’enveloppe
 ID uuid

Un UUID unique qui identifie l’enveloppe.
Créé à
 createdAt date-time

Horodatage UTC indiquant quand l’enveloppe a été créée.
Dernière modification à
 lastModifiedAt date-time

Horodatage UTC indiquant quand l’enveloppe a été modifiée pour la dernière fois.
Nom de l’enveloppe
 name string

Nom de l’enveloppe.
État de l’enveloppe
 status string

État interne de l’enveloppe.
Mode de signature
 mode string

Mode de signature configuré pour l’enveloppe.
notification
 notification EnvelopeNotification

Paramètres d’e-mail de notification pour une enveloppe de signe Nitro.

ListDocumentsByEnvelopeIDResponse

Réponse retournée lors de la liste des documents associés à une enveloppe de signe Nitro.

Nom Chemin d’accès Type Description
Documents
 items array of DocumentResponse

Liste des documents associés à l’enveloppe.

DocumentResponse

Détails du document Nitro Sign.

Nom Chemin d’accès Type Description
ID du document
 ID uuid

Un UUID unique qui identifie le document.
Nom du document
 name string

Nom du document.
Créé à
 createdAt date-time

Horodatage UTC indiquant quand le document a été créé.
Taille en octets
 sizeBytes integer

Taille du document en octets.
Nombre de pages
 numPages integer

Nombre de pages dans le document.
État du document
 status string

État actuel du document.

FieldsResponse

Réponse retournée après avoir créé un ou plusieurs champs.

Nom Chemin d’accès Type Description
Fields
 items array of FieldResponse

Champs créés dans cette requête.

FieldResponse

Détails du champ Nitro Sign.

Nom Chemin d’accès Type Description
Identifiant du champ
 ID uuid

UUID unique qui identifie le champ.
Identifiant du participant
 participantID uuid

Identificateur unique du participant affecté au champ.
ID du document
 documentID uuid

Identificateur unique du document auquel appartient le champ.
Page
 page integer

Numéro de page dans lequel le champ s’affiche.
Cadre englobant
 boundingBox array of float

Tableau de quatre nombres au format [x, y, largeur, hauteur], mesuré en points.
Obligatoire
 required boolean

Indique si le participant doit effectuer ce champ.
Type de champ
 type string

Type du champ.
Format
 format string

Format de champ, le cas échéant.
Modifiable
 modifiable boolean

Indique si la valeur du champ est modifiable, le cas échéant.

ParticipantsResponse

Réponse retournée après avoir créé un ou plusieurs participants.

Nom Chemin d’accès Type Description
Participants
 items array of ParticipantResponse

Les participants créés dans cette demande.

ParticipantsListResponse

Réponse retournée lors de la liste des participants associés à une enveloppe de signe Nitro.

Nom Chemin d’accès Type Description
Participants
 items array of ParticipantResponse

Participants associés à l’enveloppe.
Total Participants
 total integer

Nombre total de participants disponibles dans la collection.

ParticipantResponse

Détails du participant Nitro Sign.

Nom Chemin d’accès Type Description
Identifiant du participant
 ID uuid

Un UUID unique qui identifie le participant.
Email
 email email

Adresse e-mail du participant.
Role
 role string

Rôle du participant.
authentication
 authentication ParticipantAuthenticationResponse

Paramètres d’authentification retournés pour un participant.

ParticipantAuthenticationResponse

Paramètres d’authentification retournés pour un participant.

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

Type d’authentification du participant.
Code d'accès
 accessCode string

Code d’accès configuré pour le participant.

FileDownloadResponse

Fichier téléchargé encapsulé sous forme d’enveloppe JSON.

Nom Chemin d’accès Type Description
Nom du fichier
 fileName string

Nom du fichier téléchargé, dérivé de l’en-tête Content-Disposition de la réponse (par exemple, result.zip ou result.pdf). Supprimez ce jeton directement dans l’entrée Nom de fichier d’une action en aval telle que OneDrive ou SharePoint Créer un fichier.
Type de contenu de fichier
 fileContentType string

Type MIME du fichier téléchargé, par exemple application/zip ou application/pdf.
Contenu du fichier
 fileContent byte

Contenu du fichier encodé en base64. Supprimez ce jeton directement dans l’entrée de contenu de fichier d’une action en aval (par exemple, OneDrive ou SharePoint Créer un fichier, ou une autre action Nitro) : aucune expression n’est requise.