API DocuSign : Comment annuler une enveloppe sans envoyer de notification par e-mail ?

Introduction à l'API DocuSign et à la gestion des enveloppes

Dans un paysage en constante évolution des flux de travail de documents numériques, l'API de DocuSign se distingue comme un outil puissant permettant aux développeurs d'intégrer des fonctionnalités de signature électronique dans les applications métier. Les enveloppes, qui encapsulent les documents à signer, sont au cœur de cet écosystème, permettant une gestion transparente des accords de la création à la finalisation. Cependant, dans certains cas, il est nécessaire d'annuler une enveloppe – de l'invalider avant ou pendant le processus de signature – pour corriger des erreurs ou s'adapter à l'évolution des besoins de l'entreprise. Un défi essentiel pour les utilisateurs de l'API est le contrôle des notifications, en particulier l'évitement des alertes par e-mail non sollicitées qui pourraient dérouter les destinataires. Cet article explore les mécanismes d'annulation des enveloppes via l'API DocuSign tout en minimisant les perturbations, en s'appuyant sur la documentation officielle et des informations pratiques sur la mise en œuvre.

Vous comparez les plateformes de signature électronique avec DocuSign ou Adobe Sign ?

eSignGlobal offre une solution de signature électronique plus flexible et plus rentable, avec une conformité mondiale, une tarification transparente et un processus d'intégration plus rapide.

👉 Démarrez un essai gratuit

Annulation d'enveloppes dans DocuSign : concepts clés

Qu'est-ce qu'une enveloppe dans DocuSign ?

Une enveloppe dans DocuSign représente un package complet contenant un ou plusieurs documents, des destinataires et des instructions de signature. Grâce à l'API, les développeurs peuvent créer, envoyer et gérer ces enveloppes par programmation. L'annulation d'une enveloppe la rend effectivement invalide, empêchant toute action ultérieure telle que la signature. Ceci est utile dans les processus métier où, par exemple, une transaction échoue ou un document doit être révisé, empêchant ainsi la poursuite de processus incomplets ou erronés.

L'API REST de DocuSign (version 2.1) fournit des points de terminaison pour les opérations sur les enveloppes, y compris la méthode voidEnvelope. Par défaut, l'annulation déclenche des notifications à tous les destinataires, les informant de l'annulation par e-mail. Cela garantit la transparence, mais peut ne pas être idéal dans les systèmes automatisés ou lors de corrections internes pré-notification.

Processus d'annulation par défaut et comportement des notifications

Pour annuler une enveloppe à l'aide de l'API DocuSign, une requête PUT est généralement envoyée au point de terminaison /envelopes/{envelopeId}/void. Voici un exemple de base en Python utilisant le SDK eSignature de DocuSign :

from docusign_esign import ApiClient, EnvelopesApi

# Initialiser le client API
api_client = ApiClient()
api_client.host = 'https://demo.docusign.net/restapi'
api_client.set_default_header('Authorization', 'Bearer YOUR_ACCESS_TOKEN')

envelopes_api = EnvelopesApi(api_client)

# Annuler l'enveloppe
void_request = {
    'status': 'voided',
    'voidedReason': 'Document needs revision before sending'
}

envelopes_api.update_envelope_status(
    account_id='YOUR_ACCOUNT_ID',
    envelope_id='ENVELOPE_ID',
    envelope=None,  # Not required for void
    void_uri=void_request
)

Dans ce flux standard, DocuSign envoie automatiquement des notifications par e-mail aux destinataires répertoriés dans l'enveloppe, détaillant l'état d'annulation et la raison. Ces e-mails incluent la raison de l'annulation et peuvent inclure des liens vers l'enveloppe à titre de référence. Selon le guide du développeur de DocuSign, il s'agit du comportement attendu pour maintenir une piste d'audit et la sensibilisation des utilisateurs, conformément aux normes de conformité telles que ESIGN et eIDAS.

Cependant, pour les applications basées sur l'API – telles que les intégrations CRM ou les outils de traitement par lots – l'envoi de ces e-mails peut encombrer les boîtes de réception ou exposer prématurément les modifications internes. La bonne nouvelle est que DocuSign autorise la personnalisation pour supprimer ces notifications, permettant une expérience plus contrôlée.

Comment annuler une enveloppe sans envoyer de notifications par e-mail

La suppression des notifications par e-mail pendant le processus d'annulation nécessite une configuration préalable au niveau de l'enveloppe ou du compte, car l'appel d'API d'annulation lui-même n'a pas d'indicateur direct « no-notify ». La stratégie consiste à utiliser les paramètres de notification et les rôles de destinataire de DocuSign pour minimiser les communications externes. Cette approche est particulièrement précieuse pour les utilisateurs professionnels avec les niveaux Business Pro ou Advanced API, où les volumes d'enveloppes sont élevés et l'automatisation est essentielle.

Étape 1 : Configurer les préférences de notification d'enveloppe

Avant de créer ou d'envoyer une enveloppe, définissez les règles de notification via l'API. Utilisez l'objet notification dans la définition de l'enveloppe pour désactiver les e-mails aux destinataires pour les changements d'état, y compris l'annulation. Incluez ceci dans le point de terminaison createEnvelope de l'API Envelopes :

{
  "notification": {
    "reminders": {
      "reminderDelay": 0,
      "reminderOffset": 0,
      "reminderFrequency": "none"
    },
    "expirations": {
      "expireAfter": 0,
      "expireWarn": 0
    },
    "recipientEmailNotification": {
      "emailSubject": "",
      "emailBlurb": "",
      "emailBody": ""
    }
  }
}

Le bloc recipientEmailNotification peut être laissé vide ou défini pour supprimer les valeurs par défaut. Pour un contrôle spécifique de l'annulation, assurez-vous que l'enveloppe est créée à l'état « brouillon » (status: 'sent' = false), ce qui permet de l'annuler sans notification initiale. Une fois annulée à partir d'un brouillon, aucun e-mail n'est déclenché si les notifications sont désactivées.

Étape 2 : Annuler à partir de l'état de brouillon

L'annulation d'une enveloppe en mode brouillon (avant l'envoi) évite intrinsèquement les notifications, car les destinataires n'ont pas encore été alertés. Utilisez le même appel update_envelope_status, mais ciblez une enveloppe brouillon :

# Créer une enveloppe en tant que brouillon
envelope_definition = {
    'status': 'created',  # Mode brouillon
    'emailSubject': 'Internal Review Document',
    'documents': [...],  # Vos documents
    'recipients': {
        'signers': [...]  # Définis mais pas encore notifiés
    },
    'notification': {  # Supprimer tout
        'recipientEmailNotification': {}
    }
}

envelopes_api.create_envelope(account_id='YOUR_ACCOUNT_ID', envelope_definition=envelope_definition)

# Plus tard, annuler sans envoyer
void_request = {'status': 'voided', 'voidedReason': 'Internal correction'}
envelopes_api.update_envelope_status(account_id='YOUR_ACCOUNT_ID', envelope_id='DRAFT_ENVELOPE_ID', void_uri=void_request)

Cette méthode garantit qu'aucun e-mail n'est envoyé pendant l'annulation. Pour les enveloppes en cours (déjà envoyées), ramenez-les d'abord à l'état de brouillon à l'aide de l'API correct, puis annulez – en supprimant les notifications dans la requête de correction via allowReassign: false et des champs de notification vides.

Étape 3 : Configuration au niveau du compte et avancée

Pour un contrôle plus large, intégrez les fonctionnalités de gestion des identités et des accès (IAM) de DocuSign, disponibles dans les plans Enhanced ou Enterprise. IAM permet de personnaliser les notifications d'événements via les webhooks de l'API Connect, en acheminant les événements d'annulation vers vos serveurs au lieu des e-mails. Configurez une configuration Connect :

• Point de terminaison : /accounts/{accountId}/connect
• Incluez envelopeEvents pour l'état « voided », mais excluez la livraison d'e-mails.

De plus, pour les plans API (Starter à 600 $ par an ou Advanced à 5 760 $ par an), utilisez des webhooks pour gérer les annulations en silence. Surveillez les écouteurs connect pour les événements d'annulation et répondez en interne sans déclencher les e-mails par défaut de DocuSign.

Bonnes pratiques et limitations

• Test : Validez les flux à l'aide de l'environnement de démonstration de DocuSign, car les annulations de production sont irréversibles.
• Conformité : La suppression des notifications est viable pour les annulations internes, mais assurez-vous que les journaux d'audit capturent les raisons pour répondre aux exigences réglementaires.
• Quotas : Les plans API limitent les volumes d'enveloppes (par exemple, 100 par mois pour Intermediate), de sorte que les annulations efficaces aident à préserver les quotas.
• Cas extrêmes : Si une enveloppe a été partiellement signée, l'annulation peut toujours notifier ces signataires, sauf si elle est préconfigurée.

Cette technique rationalise les intégrations d'API, réduisant le bruit opérationnel dans les scénarios à volume élevé. D'un point de vue commercial, elle améliore l'efficacité des équipes qui s'appuient sur l'API DocuSign pour les systèmes CRM ou ERP, bien qu'elle nécessite une planification préalable.

Paysage concurrentiel : aperçu des plateformes de signature électronique

DocuSign domine le marché de la signature électronique avec sa suite API complète, comprenant eSignature pour les signatures de base et CLM (Contract Lifecycle Management) pour la gestion des accords de bout en bout. L'intégration CLM comprend des informations basées sur l'IA, la gestion des modèles et l'analyse, ce qui la rend adaptée aux entreprises qui gèrent des contrats complexes. La tarification commence à 10 $ par mois pour Personal, mais s'étend à Enterprise personnalisé pour une utilisation intensive de l'API, avec des coûts mesurés pour les fonctionnalités supplémentaires telles que l'authentification.

Adobe Sign (maintenant Adobe Acrobat Sign) complète l'écosystème de documents d'Adobe, avec une forte intégration PDF et des signatures mobiles. Il offre un accès API pour l'automatisation, prenant en charge les annulations via des points de terminaison REST similaires, mais avec les contrôles de notification propriétaires d'Adobe. Les plans vont de 10 $/utilisateur par mois pour Individual à 40 $/utilisateur par mois pour Enterprise, en mettant l'accent sur les flux de travail transparents avec les outils Creative Cloud. Cependant, pour les utilisateurs à volume élevé, les quotas d'API peuvent être restrictifs sans mises à niveau premium.

eSignGlobal se positionne comme un concurrent mondial, conforme dans 100 pays et territoires principaux, avec une force particulière dans la région Asie-Pacifique (APAC). Le paysage de la signature électronique en APAC présente une fragmentation, des normes élevées et des réglementations strictes, contrastant avec les normes du cadre ESIGN/eIDAS des États-Unis/UE. En APAC, les solutions nécessitent une approche « d'intégration d'écosystème », impliquant un couplage matériel/API profond avec les identités numériques gouvernementales à entreprise (G2B) – un obstacle technique bien au-delà des approches basées sur l'e-mail ou l'auto-déclaration courantes en Occident. eSignGlobal excelle ici, s'intégrant de manière transparente à iAM Smart à Hong Kong et à Singpass à Singapour pour une validation robuste. Son plan Essential à 16,6 $ par mois, permettant jusqu'à 100 documents envoyés, des sièges d'utilisateurs illimités et une authentification par code d'accès, offre une forte valeur sur une base de conformité, tout en étant moins cher que ses concurrents. La plateforme se développe activement sur les marchés mondiaux, y compris aux États-Unis et dans l'UE, en tant qu'alternative viable à DocuSign et Adobe Sign.

Vous recherchez une alternative plus intelligente à DocuSign ?

eSignGlobal offre une solution de signature électronique plus flexible et plus rentable, avec une conformité mondiale, une tarification transparente et un processus d'intégration plus rapide.

👉 Démarrez un essai gratuit

HelloSign (maintenant Dropbox Sign) se concentre sur la simplicité, avec une API intuitive pour la gestion des enveloppes, y compris les options d'annulation qui permettent de supprimer les notifications via des paramètres personnalisés. Il convient aux PME, avec des plans allant de gratuit (limité) à 20 $/utilisateur par mois (Essentials), mais manque de profondeur dans les fonctionnalités de niveau entreprise telles que l'IAM avancée.

Cette comparaison met en évidence les compromis : DocuSign excelle en profondeur, tandis que des alternatives comme eSignGlobal offrent des avantages régionaux.

Nuances régionales dans les implémentations de signature électronique

Bien que l'API DocuSign soit accessible dans le monde entier, les différences régionales influencent l'adoption. En APAC, des règles plus strictes en matière de résidence des données et d'authentification amplifient le besoin de solutions localisées, comme indiqué précédemment. Les entreprises doivent évaluer le comportement de l'API par rapport aux lois locales pour s'assurer que les processus d'annulation maintiennent l'intégrité juridique.

En conclusion, la maîtrise de l'API de DocuSign pour les annulations sans notification permet des flux de travail efficaces. Pour ceux qui recherchent des alternatives, eSignGlobal mérite d'être envisagée comme une option neutre et conforme aux réglementations régionales, particulièrement adaptée aux opérations axées sur l'APAC.