Passer au contenu principal
POST
@firma-dev/sdk

Autorisations

Authorization
string
header
requis

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

application/json
name
string
requis

Nom du modèle

Maximum string length: 255
Exemple:

"Employment Contract Template"

document
string<byte>
requis

Document PDF ou DOCX encodé en base64. Les fichiers DOCX sont automatiquement convertis en PDF. Taille maximale : 20 Mo. L'API extrait automatiquement le nombre de pages du document. (mutuellement exclusif avec document_id)

Exemple:

"JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAwIFIKL1Jlc291c..."

description
string

Description du modèle

Exemple:

"Standard employment contract for new hires"

expiration_hours
integer
défaut:168

Heures avant l'expiration de la demande de signature

Exemple:

168

settings
object
document_id
string<uuid>

ID d'un document précédemment téléversé (mutuellement exclusif avec document). À obtenir en appelant d'abord POST /documents.

Exemple:

"123e4567-e89b-12d3-a456-426614174000"

Réponse

Modèle créé avec succès

id
string<uuid>
requis

Identifiant unique du modèle

name
string
requis

Nom du modèle

Maximum string length: 255
created_date
string<date-time>
requis

Timestamp de création du modèle

description
string | null

Description du modèle

document_url
string<uri>

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é.

document_url_expires_at
string<date-time> | null

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.

page_count
integer

Nombre de pages dans le document

Plage requise: x >= 1
expiration_hours
integer
défaut:168

Nombre d'heures avant l'expiration des demandes de signature créées à partir de ce modèle

Plage requise: x >= 1
credit_cost
integer
défaut:1

Nombre de crédits consommés lorsqu'une demande de signature est envoyée à partir de ce modèle. La valeur minimale est 1.

Plage requise: x >= 1
settings
object

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é).

recipients
object[]

Destinataires du modèle (inclus dans la récupération d'un seul modèle)

fields
object[]

Champs du modèle (inclus dans la récupération d'un seul modèle)

updated_date
string<date-time>

Timestamp de dernière mise à jour du modèle