Créer une demande de signature

Compatibilité du projet

Windows | Multiplate-forme

Vue d'ensemble (Overview)

Description	méthode API	Chemin d'accès à l'API
Créez une demande de signature pour un document à l'aide d'un modèle Box Sign.	Publier	/requêtes_signations/send

Remarque :

Pour créer une demande de signature à l'aide de l'activité Créer une demande de signature, les documents utilisés dans le processus doivent disposer de balises de modèle.

Les balises de modèle constituent un moyen d'ajouter des données à un document de base que Box Sign reconnaît automatiquement. Pour apprendre à créer des modèles à l'aide de balises, consultez la documentation officielle Box.

Entrée

Paramètre	Description	Type de données
Adresses e-mail des signataires	Les adresses e-mail de tous les signataires requis. L'ordre des signataires peut être spécifié, le premier signataire étant désigné comme index 0.	string
Fichier à signer	Le fichier pour lequel la requête de signature est en cours de création.	Liste de données
Dossier de destination	Le dossier dans lequel le document signé sera enregistré une fois terminé.	Liste de données
Modèle	Le modèle Box Sign à utiliser pour le processus de signature. Les modèles peuvent être créés directement dans Box.	Liste de données
Objet de l’e-mail	Objet de l'e-mail de demande de signature envoyé aux destinataires.	string
MessageÉlectronique	Le corps du message inclus dans l'e-mail envoyé aux signataires.	string
Rappels	Si cette option est activée, Box enverra automatiquement des rappels aux signataires exceptionnels les jours 3, 8, 13 et 18.	boolean
Jours valables	Le nombre de jours après lesquels la demande de signature expirera automatiquement si elle n’est pas terminée.	Int32
Les signatures de texte sont-elles activées	Détermine si les signataires sont autorisés à signer en saisissant leurs noms. Si cette option est désactivée, seules les signatures tracées ou téléchargées sont autorisées.	boolean
ID externe	Un identificateur utilisé pour référencer la requête de signature dans un système externe.	string
Pré-remplir la valeur du texte des balises	Valeur de texte pour pré-remplir une balise de texte correspondante définie dans le modèle.	string
Préremplir les valeurs de date des balises	Une valeur de date utilisée pour pré-remplir une balise de date définie dans le modèle.	DateTime
Une préparation est-elle nécessaire	Indique si une préparation du document (par exemple, la configuration des champs) est requise avant l'envoi.	boolean
Préremplir les balises	Une valeur booléenne utilisée pour préremplir un champ de case à cocher dans le modèle.	boolean
Pré-remplir les balises ID de balise de document	L'ID de balise du champ pré-rempli, tel que défini dans le modèle Box Sign.	string

Remarque :

Les balises de modèle sont attribuées dans l'ordre dans lequel les adresses e-mail sont ajoutées au champ E-mails du signataire . Il ne s'agit pas du même ordre de signature. S'il y a plus de balises sur le document que de signataires réels, ces balises ne sont pas renseignées. Si vous ajoutez plus de signataires que de balises, les signataires supplémentaires peuvent signer le document, mais ne sont pas redirigés vers les emplacements du document. Ils peuvent ajouter du texte, des dates et des signatures où ils le souhaitent dans le document.

Sortie

Paramètre	Description	Type de données
ID de requête de signature	Identificateur unique de la requête de signature récemment créée.	string
Créer une demande de signature	Objet de réponse complète détaillant la requête de signature créée.	object

Remarque :

• Dans les workflows d’API, un seul objet de réponse est renvoyé en tant que sortie. Tous les champs obligatoires peuvent être extraits directement de cet objet.
• Dans les workflows RPA, certains paramètres de sortie peuvent différer, mais les valeurs nécessaires peuvent toujours être récupérées à partir de l'objet de réponse même s'ils ne sont pas explicitement exposés.