Aller au contenu principal

Journal des modifications de l’API REST

Modifications apportées à l’API REST v1 (/api/v1/).


2027​

2027-10-27​

Ressource TemplatePDF — POST /api/v1/templatepdf/{pdfId}/preview/ remplace le GET pour générer des aperçus PDF avec les champs de l’expéditeur pré-remplis. Le GET reste pris en charge.


2026​

2026-08-26​

Ressource TemplatePDF — Nouveau point d’accès : GET /api/v1/templatepdf/{pdfId}/preview/ — retourne un aperçu PDF pour le modèle spécifié.

2026-08-14​

Ressource Élément/Champ — GET /api/v1/document/{id}/fields/ — ajout du paramètre de filtre de requête element_type. Voir Get Document Fields.

2026-07-02​

Ressource TemplatePDF — Nouveau point d’accès : GET /api/v1/templatepdf/{id}/component-token/ — renvoie un jeton de composant viewer pour intégrer le composant de visualisation PDF.

2026-07-01​

Ressource Signataire — Nouveau point d’accès : GET /api/v1/signer/{id}/component-token/ — renvoie un jeton de composant pour intégrer le composant de signature. Nécessite une clé API non héritée et que le groupe soit activé pour l’utilisation des composants.

2026-05-20​

Ressource Document — Les liens de signature retournés dans la réponse API pour les signataires sont désormais conservés au format héritage pour la compatibilité rétroactive lors de l’utilisation de la signature groupée/salle d’attente.

2026-04-28​

Authentification — Un nouveau schéma de clé API est désormais disponible. Les clés existantes continuent de fonctionner. Il est fortement recommandé aux développeurs de mettre à jour — voir developer.legalesign.com pour les détails.

2026-01-21​

Ressource TemplatePDF — DELETE /api/v1/templatepdf/{id}/delete/ — suppression mise à jour pour une suppression sécurisée. Renvoie une erreur en cas d’échec (ex. : la politique de conservation requiert une approbation secondaire).

2026-01-06–07​

Ressource Document — Ajout du champ booléen append_history à l’envoi de document et à la réponse des détails. Lorsque true, la page historique de signature est ajoutée au PDF final (comportement similaire à append_pdf existant).

Déprécié : les champs sign_mouse, sign_type, sign_upload sur la ressource document sont dépréciés et seront retirés dans une future version.


2025​

2025-12-18–19​

Ressource Document — Ajout du paramètre skip pour les signataires lors de l’envoi d’un document. En réglant skip: true sur une position de signataire, ce destinataire est omis de l’envoi. Les témoins suivant un signataire ignoré sont également automatiquement ignorés.

2025-10-30​

Ressource Document — La création de la politique de conservation a été déplacée de l’envoi via l’API vers le flux de signature.

2025-10-08​

  • Ressource Document — La réponse GET /api/v1/document/{id}/ inclut désormais un tableau signer_objects en plus du tableau signers existant. Chaque objet contient : firstname, lastname, email, tel, status, order, resource_uri, role, uuid.
  • Ressource Signataire — Le champ role a été ajouté à la réponse signataire ("signer", "approver", ou "witness").

2025-09-26​

  • Ressource Document — DELETE /api/v1/document/{id}/ — ajout du paramètre optionnel email=1 pour envoyer des emails de notification lors de la suppression.
  • Ressource TemplatePDF — ajout du paramètre hide_sender_fields au point d’édition PDF.
  • Ressource Élément/Champ — les recherches pdftext et signertext acceptent désormais les UUID en plus des noms d’étiquette.
  • Ressource Signataire — ajout du champ uuid dans l’objet réponse signataire.

2025-09-04​

Ressource Document — Lorsqu’aucun message n’est fourni lors de l’envoi, le modèle de message par défaut du groupe est désormais utilisé automatiquement.

2025-08-22​

Ressource Document — Lors de l’envoi d’un document, le PDF source est désormais copié du modèle vers l’enregistrement du document.

2025-06-10​

Ressource TemplatePDF — Nouveau point d’accès : POST /api/v1/templatepdf/{id}/archive/ — archive un PDF modèle.


2024​

2024-10-17​

Ressource Document — Suppression du paramètre déprécié append_to du signataire. Ce paramètre n’avait aucun effet et a été retiré.

2024-08-21​

  • Ressource Utilisateur — Les utilisateurs créés via l’API reçoivent désormais un mot de passe permanent (et non temporaire nécessitant une réinitialisation).
  • Ressource Document — Prise en charge correcte des valeurs signataire d’élément admin pour l’index signataire 0.

2024-08-20​

  • Ressource Document — Les paramètres convert_sender_to_signer et strict_fields acceptent désormais true/"true"/1 (auparavant uniquement booléen True).
  • Ressource Signataire/Élément — Le champ signer est désormais nullable ; les éléments element_type: "admin" ont par défaut le signataire 0.
  • Rôles — Les rôles API se synchronisent désormais avec la console après la création d’un document.
  • Messages d’erreur — Amélioration des erreurs lorsqu’un utilisateur n’a pas de lien vers une organisation.

2024-08-19​

Ressource Groupe (Tab) — POST /api/v1/group/ — name est désormais le seul champ requis. xframe_allow est maintenant un paramètre optionnel.

2024-07-16​

Ressource Document — Le paramètre cc accepte désormais la valeur "default" pour utiliser la liste email CC par défaut du groupe.

2024-06-14​

Ressource Document — Ajout des champs pdf_password et pdf_password_type à la réponse détaillée du document.

2024-02-20​

Ressource TemplatePDF — GET /api/v1/templatepdf/{id}/ (téléchargement PDF) — ajout du paramètre de requête returnAsJson pour retourner le PDF en réponse JSON encodée en base64 au lieu d’un téléchargement fichier.

2024-02-09​

Ressource TemplatePDF — Correction d’une faute de frappe dans la réponse returnAsJson : documet_uri → document_uri.

2024-01-26​

Ressource TemplatePDF — POST /api/v1/templatepdf/ — ajout du paramètre optionnel returnAsJson. Lorsqu’il est activé, le corps de la réponse inclut { resource: { uid, status_uri, document_uri } } au lieu d’un 201 vide.

2024-01-21​

Ressource Document — Amélioration de performance : GET /api/v1/document/ optimisé (requête de comptage plus rapide).


2023​

2023-09-27​

Ressource Document — GET /api/v1/document/ — ajout de deux nouveaux paramètres de filtre de requête :

  • created_gt — filtre les documents créés après une date-heure donnée (ISO 8601)
  • modified_gt — filtre les documents modifiés après une date-heure donnée (ISO 8601)

Les URLs de pagination next/previous incluent désormais correctement tous les paramètres de filtre actifs.

2023-08-08​

Ressource Document — GET /api/v1/document/ — ajout du paramètre de filtre sentUserId.

2023-07-07​

Ressource Utilisateur — Les utilisateurs admin peuvent désormais créer des sous-utilisateurs via l’API.

2023-05-31​

Ressource Document — Les témoins ne sont plus inclus dans la liste des destinataires par défaut des rappels.

2023-04-17​

  • Ressource Signataire — Ajout du champ rejection_reason dans la réponse signataire.
  • Nomination — Corrections pour la cohérence des noms de champs à travers l’API.

2023-03-02​

Webhooks — Extension de la longueur maximale du champ callback_url de 200 à 500 caractères.

2023-01-17​

Ressource Document — Ajout des champs tag2 et tag3 (en plus des champs existants tag/tag1) à l’envoi et à la réponse du document.


2022​

2022-11-14–15​

Ressource Document — Augmentation du nombre maximum de champs autorisés par document.

2022-11-02–03​

Webhooks — Ajout de nouveaux types d’événements webhook. Mise à jour des éléments usercallback.

2022-09-09​

Ressource Document — Ajout du paramètre de requête message_template pour spécifier un modèle de message lors de l’envoi.

2022-05-12​

Ressource Élément/Champ — Ajout du champ no_pdf : option pour marquer un champ afin qu’il ne soit pas rendu dans le PDF final.

2022-04-20​

  • Ressource Document — Le champ role n’est plus requis dans le dictionnaire signataire lors de l’envoi d’un document via un TemplatePDF.
  • Rapport d’erreur — Amélioration des messages d’erreur dans toute l’API.

2022-04-06​

Ressource Élément/Champ — Ajout du type de validation regex (type de validation 93) pour les valeurs de champ.

2022-02-24​

Ressource Élément/Champ — Ajout du champ label_extra.

2022-02-22​

Ressource TemplatePDF — Ajout de l’option force_download pour la récupération de brouillon PDF.

2022-02-17​

Ressource Document — Prise en charge des reviewers lors de l’envoi d’un document.

2022-02-15​

Ressource Document — Ajout de la prise en charge du champ honorifics sur la requête POST document.


2021​

2021-11-30​

Ressource Document — Nouveau point d’accès : GET /api/v1/document/{id}/auditlog/ — renvoie le journal d’audit d’un document.

2021-10-31​

Ressource Document — La réponse GET /api/v1/document/ inclut désormais un champ tag.

2021-10-30​

Ressource Document — La réponse GET /api/v1/document/ inclut désormais un champ location.

2021-10-28​

Ressource Document — Ajout de la prise en charge de la validation de champ lors de l’envoi de documents via l’API.

2021-10-27​

Ressource Document — Nouveau point d’accès : GET /api/v1/document/{id}/fields/ — renvoie les données des champs d’un document.

2021-10-25​

Ressource Document — Ajout de la prise en charge de bundle. Ajout du paramètre convert_sender_to_signer lors de l’envoi d’un document.

2021-08-17​

Ressource TemplatePDF — Ajout du champ archive_upon_send à la liste des champs de la ressource Template PDF.