The Drupal Dropbox Sign module is a Drupal integration for the Dropbox Sign electronic signature API (formerly HelloSign). This module provides seamless integration with the Dropbox Sign API, allowing users to manage and process electronic signature requests directly from Drupal.
Module Description
This module was inspired by and based on the original HelloSign module, which integrated Drupal with the HelloSign API. After HelloSign was acquired by Dropbox in 2019, the HelloSign API evolved into the Dropbox Sign API. The module we are offering today has adapted the previous module to support the new API, while maintaining the core features of the original HelloSign integration.
- For a complete description of the module, visit the project page:
https://www.drupal.org/project/dropbox_sign - To submit bug reports and feature suggestions, or to track changes:
https://www.drupal.org/project/issues/dropbox_sign - For more information about Dropbox Sign and its features:
https://sign.dropbox.com/features
Requirements and configurations
Requirements
This module requires the Dropbox Sign PHP SDK.
This module requires the Encryption module as a dependency.
Configuration
Configure Dropbox Sign in Administration » Configuration » System » Dropbox Sign API or by going directly to /admin/config/system/dropbox-sign:
- Dropbox Sign API Key:
API key associated with your Dropbox Sign account. You can create an account at https://app.hellosign.com/account/signUp.
- Dropbox Sign Client ID:
The client ID associated with your Dropbox Sign project. Once you have a Dropbox Sign account, you can create a client for your domain name and you will be assigned a client ID.
- CC Email Addresses:
Add a comma-separated list of email addresses to be copied on every Dropbox Sign signature request. Useful if you want to track completed requests by email without having to manually add an extra address to each signature request.
- Test Mode:
Allows you to enable and disable test mode. In test mode, all requests sent to Dropbox Sign will indicate that they are test requests.
Using the API
API Connection
To create a new Signature Request API connection, retrieve the Dropbox Sign service and call getSignatureRequestApi().
$signatureApi = \Drupal::service('dropbox_sign')->getSignatureRequestApi()Signature Request
To create a new signature request, call the createSignatureRequest method on the Dropbox Sign service with the following parameters:
$title: Document title
$subject: Email subject
$signers: Array of signers with an email address key and a name value
$file: A complete path to a local system file
$mode: The type of signature request, either "embedded" or "email"
$redirectUrl: The URL to redirect to after the signature is completed (Optional)
$msg: The email content to send for the signature request (Optional)
If successful, it returns a signature_request_id token from Dropbox Sign and an
array of signatures. If it fails, it returns an empty array.
Get the Signature URL
To get the sign_url for SignatureEmbedRequest, retrieve the
Dropbox Sign service and call getSignUrl().
$sign_url = \Drupal::service('dropbox_sign')->getSignUrl($signatureId)Other Methods
To use any of the other methods required by Dropbox Sign PHP, simply
call these methods on signatureApi. Example:
$signatureApi->signatureRequestCancel($signature_request_id)Custom Templates
To include a signature placeholder in custom templates, simply add this tag, which represents a placeholder for the signature request from the first signer:
[sig|req|signer1]:
Support: Agence bluedrop.fr
drupal.org URL: https://www.drupal.org/project/dropbox_sign
Thanks to Lara and Elia for this work.
Module developed on the occasion of the development of the site https://www.lamedecinelibre.com.