Créer un Modèle
Crée un nouveau modèle avec un document PDF encodé en base64. L’API extrait automatiquement le nombre de pages du document.
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
Nom du modèle
255"Employment Contract Template"
Description du modèle
"Standard employment contract for new hires"
Document PDF ou DOCX encodé en base64. Les fichiers DOCX sont automatiquement convertis en PDF. L'API extrait automatiquement le nombre de pages du document. Pour les documents de plus de 5 Mo, utilisez POST /documents et transmettez le document_id à la place. (mutuellement exclusif avec document_id et document_ids)
"JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAwIFIKL1Jlc291c..."
Heures avant l'expiration de la demande de signature
168
ID d'un document précédemment téléversé (mutuellement exclusif avec document). À obtenir en appelant d'abord POST /documents.
"123e4567-e89b-12d3-a456-426614174000"
Identifiants de téléversement temporaire de POST /documents, dans l'ordre des documents, pour créer un modèle multi-documents (activation requise). Exactement un parmi document, document_id ou document_ids (400 CONFLICTING_DOCUMENT_SOURCE) ; un identifiant répété répond 400 DUPLICATE_DOCUMENT_ID, plus de 20 400 MAX_DOCUMENTS_EXCEEDED, un téléversement inconnu ou expiré 400 DOCUMENT_UPLOAD_NOT_FOUND, un ensemble de plus de 100 Mo 413 DOCUMENT_SET_TOO_LARGE.
1 - 20 elementsRéponse
Modèle créé avec succès
Identifiant unique du modèle
Nom du modèle
255Timestamp de création du modèle
Description du modèle
URL pré-signée vers le document PDF. Il s'agit d'une URL signée à durée limitée pour un accès sécurisé, voir document_url_expires_at pour la date d'expiration. Les URL initiales sont valables 7 jours ; les URL rafraîchies sont valables 1 heure. Demandez une nouvelle récupération du modèle pour obtenir une URL fraîche si elle a expiré.
Timestamp ISO 8601 auquel document_url expirera. Après cette heure, l'URL retournera une erreur d'accès refusé. Récupérez à nouveau le modèle pour recevoir une nouvelle URL signée.
Nombre de pages dans le document
x >= 1Nombre d'heures avant l'expiration des demandes de signature créées à partir de ce modèle
x >= 1Nombre de crédits consommés lorsqu'une demande de signature est envoyée à partir de ce modèle. La valeur minimale est 1.
x >= 1Paramè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é).
Destinataires du modèle (inclus dans la récupération d'un seul modèle)
Champs du modèle (inclus dans la récupération d'un seul modèle)
Timestamp de dernière mise à jour du modèle
Les documents du modèle dans l'ordre des positions (multi-documents ; présent uniquement pour les entreprises activées). Sur GET /templates (la liste) : une entrée de liste ne contient pas de document_url. Un élément dont l'ensemble de documents n'a jamais été modifié apparaît ici avec documents: [], tandis que son GET individuel renvoie son unique document (avec document_id null). Sur GET /templates/{id}, PUT /templates/{id} et POST /templates : un élément dont l'ensemble de documents n'a jamais été modifié renvoie son unique document, avec document_id null.
Version de l'ensemble de documents, incrémentée à chaque modification de document (multi-documents ; entreprises activées uniquement).
Version de la mise en page des documents, incrémentée lorsque des documents sont ajoutés, supprimés ou réordonnés (multi-documents ; entreprises activées uniquement). Les écritures de champs sur une demande de signature comportant plus d'un document la renvoient sous la forme documents_layout_version.