HelloSign

This module provides basic integration functionality for initiating a HelloSign electronic signature process as well as processing event callbacks and retrieving signed documents.

Currently, only a Drupal 7 version of this module is available. A Drupal 8 version is in development.

HelloSign website: https://www.hellosign.com/
HelloSign API documentation: https://www.hellosign.com/api/documentation

Installation

1. Download the HelloSign sdk from https://github.com/HelloFax/hellosign-php-sdk
   and follow installation instructions.
   The end result should be the folder "sites/all/libraries/hellosign-php-sdk/vendor/hellosign"
2. Download and unpack the HelloSign module directory in your modules folder (this will usually be "sites/all/modules/").
3. Go to "Administer" -> "Modules" and enable the module.

Configuration

• Go to "Configuration" -> "System" -> "Hellosign" to find
  all of the configuration options.

Usage

• Generate a HelloSign signature request

  Invoke hellosign_generate_esignature_request($title, $subject, $signers, $file, $mode) to generate a new signature request.

  • $title = Document title
  • $subject = Email subject
  • $signers = array of signers with a key of email address and a value of name
  • $file = a full path to a local system file
  • $mode = Either "embedded" or "email", indicating the type of signature request
  • NOTE: Additionally, if you have added global cc emails in the configuration, these will be added to all requests

  This returns an array with status of 1 for success and 0 for failure. If failure, it also returns a "message", which contains the error string. If success, it additionally returns a signature_request_id token from HelloSign and an array of signatures.

• Process HelloSign signature events with hooks

  There is a hook called hook_process_hellosign_callback that you can use to process any events that happen to a signature request in the HelloSign system. All signature data will be passed to your function in an argument called "data".

  For info about the types of events that happen and what this data structure contains, please refer to the HelloSign docs at https://www.hellosign.com/api/eventsAndCallbacksWalkthrough.

• Fetch signed documents for HelloSign signature requests

  Invoke hellosign_fetch_esignature_document($signature_request_id) to fetch the associated document for a HelloSign signature request.
  Note that you can do this at any phase so if you fetch them before signatures are added, you will simply return the document in its original state.

  This returns a full path to a local system file.

• Generate a temporary URL for signature embedding in iframes

  Invoke hellosign_get_embed_url($signature_id) to fetch a temporary url used to embed a signature in an iframe.

• Cancel a pending signature request.

  Invoke hellosign_cancel_esignature_request($signature_request_id) to queue
  a pending signature request for deletion in hellosign.

  This can only be used on signature requests that are not yet completed and
  a callback handler can for the event 'SIGNATURE_REQUEST_CANCELED' when the
  deletion is completed.

  This returns an array with status of 1 if the call to HelloSign was successful
  and 0, along with a message, if there was a failure.