Signature Electronique

API

Points d'accès de l'API de l'application eSignature : enveloppes de signature et méthodes d'envoi.

Cette page présente l'API de l'application eSignature. Pour configurer DocuSign et envoyer un document à signer, voir eSignature.

Familles de points d'accès

L'API de l'application a deux familles de points d'accès :

  • /api/resource/<Type de document> : lister, créer, lire, modifier et supprimer les documents d'un type. Les tables enfants n'ont pas de point d'accès propre : elles sont lues et écrites avec leur document parent.
  • /api/method/<chemin.de.la.méthode> : appeler une méthode Python ouverte à l'API (décorée par @frappe.whitelist).

Types de document et méthodes d'eSignature

Les types de document exposés sont ESignature Envelope (une enveloppe de signature) et ESignature Settings (les paramètres, document unique). La table ESignature Envelope Files est une table enfant de l'enveloppe.

Les principales méthodes du module esignature.esignature.doctype.esignature_envelope.esignature_envelope sont :

  • get_envelopes_for_document : liste les enveloppes d'un document (paramètres doctype et docname) ;
  • get_envelope_link : renvoie le lien de signature d'une enveloppe ;
  • print_document_and_send_envelope : imprime un document et l'envoie à signer ;
  • get_signed_agreement : récupère le document signé.

DocuSign appelle la méthode esignature.esignature.doctype.esignature_settings.docusign.webhooks.register sans clé d'API pour notifier les changements de statut.

S'authentifier

Chaque appel s'authentifie avec les clés d'API d'un utilisateur, dans l'en-tête Authorization: token <api_key>:<api_secret>. L'API applique les droits de cet utilisateur. Pour générer les clés et connaître les principes de l'API, voir API Rest et API REST v2.

Exemple fictif

Le CRM de la société Mappemonde lit les enveloppes du devis SAL-QTN-2026-00042 :

curl -G "https://mappemonde.example.com/api/method/esignature.esignature.doctype.esignature_envelope.esignature_envelope.get_envelopes_for_document" \
  -H "Authorization: token 1a2b3c4d5e6f7a8:9f8e7d6c5b4a3f2" \
  --data-urlencode "doctype=Quotation" \
  --data-urlencode "docname=SAL-QTN-2026-00042"

La réponse contient le nom, le titre et le statut de chaque enveloppe.