Paramètres de téléchargement partiel de documents et de filigrane (API v1.16.0)

API v1.16.0 introduit deux fonctionnalités qui résolvent un problème courant : télécharger les documents de demande de signature avant que chaque signataire ait terminé, et contrôler l’apparence de ces PDF partiels avec un filigrane configurable.

Télécharger les documents à n’importe quelle étape

Avant cette mise à jour, vous ne pouviez télécharger le PDF d’une demande de signature qu’après que tous les signataires avaient terminé. Cela fonctionne bien pour de simples accords à deux parties, mais cela montre ses limites lorsque vous avez des contrats à plusieurs signataires pour lesquels les équipes juridiques ou de conformité ont besoin de visibilité sur l’avancement avant la dernière signature.

Le nouveau GET /signing-requests/{id}/download renvoie une URL de téléchargement pré-signée pour le document dans son état actuel. Il fonctionne pour tous les statuts d’une demande de signature : en cours, annulée, refusée et expirée.

Pour les demandes de signature terminées, vous obtenez le PDF signé final comme auparavant. Pour tout le reste, vous obtenez un instantané qui n’inclut que les champs complétés par les signataires qui ont déjà terminé. Les champs des signataires en attente sont entièrement omis, de sorte que le document reflète exactement ce qui a été exécuté jusqu’à présent.

Chaque PDF partiel inclut également une page de piste d’audit avec un tableau d’état par signataire et un cadre probant, vous donnant une trace claire de qui a signé, de qui ne l’a pas encore fait, et à quel moment.

Pour activer les téléchargements partiels sur une demande de signature, définissez allow_partial_download: true dans les paramètres de la demande de signature. Le document est généré à la demande lors de la première requête et mis en cache pour les appels suivants. Si le document n’a pas encore été généré, vous obtiendrez une 503 avec un en-tête Retry-After.

Contrôle du filigrane par espace de travail

Certaines équipes souhaitent que les PDF partiels soient clairement marqués comme incomplets. D’autres veulent des documents propres qu’elles peuvent transmettre aux parties prenantes sans bruit visuel. Le nouveau show_partial_watermark paramètre dans les paramètres de l’espace de travail vous donne ce contrôle.

Lorsqu’il est activé, les PDF partiels incluent un filigrane diagonal « EN COURS — PAS ENCORE EXÉCUTÉ » sur chaque page. Lorsqu’il est désactivé (par défaut), le document se télécharge sans filigrane.

Il s’agit d’un paramètre au niveau de l’espace de travail, donc si vous utilisez les espaces de travail client pour partitionner les clients de votre plateforme, chaque espace de travail peut avoir sa propre préférence de filigrane.

Détails de l’API

Voici le bref résumé de ce qui est nouveau dans l’API :

• Nouveau point de terminaison : GET /signing-requests/{id}/download renvoie un download_url pré-signé avec un horodatage expires_at

• Nouveau paramètre : allow_partial_download (booléen) dans les paramètres de demande de signature autorise les téléchargements partiels

• Nouveau paramètre d’espace de travail : show_partial_watermark (booléen | null) contrôle le filigrane diagonal sur les PDF partiels

• Statuts pris en charge : finished, in_progress, cancelled, declined, expired

Pour la spécification complète du point de terminaison, consultez la documentation de téléchargement de demande de signature. Pour les notes de migration, voir le journal des modifications de l’API.

Il s’agit d’une mise à jour non cassante. Aucun comportement existant ne change, et les intégrations existantes continueront de fonctionner sans modification.

Commencer

Si vous êtes déjà sur l’API Firma.dev, vous pouvez commencer à utiliser le nouveau point de terminaison immédiatement en mettant à jour l’en-tête de version de votre API vers v01.16.00. Si vous découvrez Firma.dev, obtenez votre clé API dès maintenant et commencez à construire gratuitement, sans carte bancaire requise.