Drupal
25/04/2024

Contribution du module Dropbox Sign sur drupal.org

Le module drupal Dropbox Sign est une intégration Drupal pour l'API de signature électronique Dropbox Sign (anciennement HelloSign). Ce module permet une intégration transparente avec l'API Dropbox Sign, permettant aux utilisateurs de gérer et de traiter les demandes de signature électronique directement depuis Drupal.

Description du module

Ce module a été inspiré et basé sur le module HelloSign original, qui intégrait Drupal à l'API HelloSign. A la suite du rachat de HelloSign par Dropbox en 2019, l'API HelloSign a évolué vers l'API Dropbox Sign. Le module que nous proposons aujourd'hui a adapté le précédent module pour prendre en charge la nouvelle API tout en conservant les fonctionnalités de base de l'intégration HelloSign d'origine.

Exigences et configurations

Exigences

Ce module nécessite le SDK PHP Dropbox Sign.
Ce module nécessite le module Encryption comme dépendance.

Configuration

Configurez Dropbox Sign in Administration » Configuration » System » Dropbox Sign API ou en accédant directement à /admin/config/system/dropbox-sign :

  • Clé API Dropbox Sign :
    clé API associée à votre compte Dropbox Sign. Vous pouvez créer un compte sur https://app.hellosign.com/account/signUp.
     
  • ID client Dropbox Sign :
    l'ID client associé à votre projet Dropbox Sign. Une fois que vous disposez d'un compte Dropbox Sign, vous pouvez créer un client pour le nom de domaine que vous utilisez et un identifiant client vous sera attribué.
     
  • Adresses e-mail CC :
    Ajoutez une liste d'adresses e-mail séparées par des virgules qui seront copiées sur chaque demande de signature Dropbox Sign. Utile si vous souhaitez suivre les demandes terminées par e-mail sans ajouter manuellement une adresse supplémentaire à chaque demande de signature.
     
  • Mode test :
    Permet d'activer et désactiver le mode test. En mode test, toutes les demandes envoyées à Dropbox Sign indiqueront qu'il s'agit de demandes de test.

Utilisation de l'API

Connexion API

Pour créer une nouvelle connexion API Signature Request, récupérez le service Dropbox Sign et appelez getSignatureRequestApi().

$signatureApi = \Drupal::service('dropbox_sign')->getSignatureRequestApi()

Demande de signature

Pour créer une nouvelle demande de signature, appelez la méthode createSignatureRequest sur le service Dropbox Sign avec les paramètres suivants :
$title: Titre du document
$subject: Objet de l'e-mail
$signers: Tableau de signataires avec une clé d'adresse e-mail et une valeur de nom
$file: Un chemin complet vers un fichier système local
$mode: Le type de demande de signature, soit "intégrée" ou "e-mail"
$redirectUrl: L'URL redirigée après la signature est faite (Facultatif)
$msg: Le contenu de l'e-mail à envoyer pour la demande de signature (Facultatif)

En cas de succès, il renvoie un jeton signature_request_id de Dropbox Sign et un
tableau de signatures. En cas d'échec, il renvoie un tableau vide.

Obtenir l'URL de signature

Pour obtenir le sign_url pour SignatureEmbedRequest, récupérez le
service Dropbox Sign et appelez getSignUrl().

$sign_url = \Drupal::service('dropbox_sign')->getSignUrl($signatureId)

Les autres méthodes

Pour utiliser l'une des autres méthodes requises par Dropbox Sign PHP, appelez simplement
ces méthodes sur signatureApi. Exemple :

$signatureApi->signatureRequestCancel($signature_request_id)

Modèles personnalisés

Pour inclure un espace réservé à la signature dans les modèles personnalisés, ajoutez simplement cette balise qui représente un espace réservé à la demande de signature du premier signataire :

[sig|req|signer1]: 

 


 

Soutien : Agence bluedrop.fr
URL drupal.org : https://www.drupal.org/project/dropbox_sign 
Merci à Lara et Elia pour ce travail.
Module développé à l'occasion des travaux de développement du site https://www.lamedecinelibre.com.