Créer une Demande de Signature
Crée une nouvelle demande de signature soit à partir d’un document PDF (basé sur un document), soit à partir d’un modèle existant (basé sur un modèle). Pour une création basée sur un document, allow_editing_before_sending est automatiquement défini sur true. Pour une création basée sur un modèle, les propriétés sont héritées du modèle et peuvent être surchargées.
Motif d’ID Temporaire : Pour une création basée sur un document, tu peux référencer des destinataires avant qu’ils soient créés en utilisant des ID temporaires (format : ‘temp_X’ où X est un identifiant quelconque, par exemple ‘temp_1’, ‘temp_alice’). Utilise ces ID temporaires dans recipient.id, field.recipient_id et reminder.recipient_id. L’API valide toutes les références et fait automatiquement correspondre les ID temporaires aux vrais UUID une fois les destinataires créés. La réponse ne contient que de vrais UUID.
Validation des ID Temporaires : Les ID temporaires doivent commencer par ‘temp_’, être uniques parmi tous les destinataires de la requête, et toutes les références de champ/rappel doivent pointer vers des destinataires définis dans la même requête. Un format invalide, des ID en double ou des références de destinataires manquantes renvoient une erreur 400 avec des messages de validation détaillés.
Autorisations
Clé API pour l'authentification. Utilisez votre clé API directement sans préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel mais pas obligatoire.
Corps
- Option 1
- Option 2
Créer une Demande de Signature à partir d'un document PDF
Document PDF ou DOCX encodé en base64. Les fichiers DOCX sont automatiquement convertis en PDF. Le nombre de pages sera extrait automatiquement.
Nom de la Demande de Signature
255Description de la Demande de Signature
Nombre d'heures avant l'expiration de la Demande de Signature (par défaut : 168 = 7 jours)
x >= 1Destinataires de la Demande de Signature. Utilise des ID temporaires (ex. 'temp_1') dans le champ id pour référencer les destinataires dans fields/reminders.
Champs à placer sur le document. Utilise recipient_id pour assigner les champs aux destinataires.
Balises d'ancrage pour le placement automatique des champs. Les marqueurs de texte dans le PDF sont localisés et convertis en champs positionnés. Le texte d'ancrage est supprimé du PDF après traitement. Les champs créés à partir de balises d'ancrage sont ajoutés en plus des champs spécifiés manuellement. Disponible uniquement pour la création basée sur un document (pas basée sur un Modèle).
100Rappels à envoyer aux destinataires
Paramètres de la Demande de Signature
Réponse
Demande de signature créée avec succès. La réponse peut inclure un tableau 'warnings' pour les avertissements de validation de format d'email (non bloquants).
Demande de signature telle que renvoyée par les endpoints CREATE (POST /signing-requests)
Identifiant unique de la demande de signature
Nom de la demande de signature
255Le statut est toujours 'draft' pour les demandes de signature nouvellement créées
draft Description de la demande de signature
URL pré-signée vers le document PDF
Nombre de pages dans le document
x >= 1Nombre d'heures avant l'expiration de la demande de signature (par défaut : 168 = 7 jours)
x >= 1ID du modèle si créé à partir d'un modèle
Paramètres renvoyés par les endpoints de liste et de détail des demandes de signature. Les modèles utilisent le schéma TemplateSettings (sans champs d'identité).
Horodatage de création
Horodatage de dernière mise à jour
Date d'envoi de la demande de signature
Date à laquelle toutes les signatures ont été complétées
Date d'annulation de la demande de signature
Destinataires de la demande de signature
Champs de la demande de signature avec des valeurs de position à plat
Avertissements optionnels de validation du format des e-mails. Présents uniquement lorsque les e-mails des destinataires ont des formats inhabituels.