gaybro8777 / signinghub_api

Example package and Flask web application to demonstrate the SigningHub API.

Synopsis

This code example illustrates the use of the SigningHub API by implementing a simple Flask web application that:

• prepares a Document,
• shows that Document in an IFrame (SigningHub Tight Integration), and
• prompts the user to sign that Document.

SigningHub API documentation:

http://manuals.ascertia.com/SigningHub-apiguide/default.aspx

SigningHub Tight Integration documentation:

https://www.signinghub.com/wp-content/uploads/2015/09/SigningHub-Quick-Integration-Guide.pdf

Motivation

I found that the API calls are well documented, but being new to this API, I struggled trying to figure out which API calls to make and in what sequence. I'm sharing this code example to provide a code illustration to other developers.

Though this code example is in Python (using the Flask application framework), it illustrates the API for developers using other programming languages.

Code organization

• signinghub_api/ contains a simple wrapper for the SigningHub API.
• example_app/ contains a simple Flask application that calls the wrapper.
• runserver.py starts a development web server that serves the Flask application.

Installation

It is assumed that you have virtualenv and virtualenvwrapper installed and configured:

# Clone this repository
mkdir ~/dev
git clone [email protected]:lingthio/signinghub_api.git signinghub_api

# Create a virtualenv
mkvirtualenv signinghub_api -p /full/path/to/python

# Install required python packages (Flask and requests)
cd ~/dev/signinghub_api
pip install -r requirements.txt

Configuring SigningHub API Application

Add a SigningHub API Application:

• Create an account at signinghub.com and log in
• Dashboard > Enterprise Actions > API Key
• Add an Application (Blue plus sign)
  • Application Name: ExampleApp # This is your SIGNINGHUB_CLIENT_ID
  • Call-back URL: http://localhost:5000/signinghub/callback # Example app must serve this URL
  • Default Authentication Method: SigningHub ID
  • Generate the API Key # This is your SIGNINGHUB_CLIENT_SECRET

Add a SigningHub Library Document:

• Dashboard > Quick Action > Templates
• Under My Settings, click on Library
• Add a Library Document (blue plus sign)
• Upload a document (You can use example_app/ExampleAgreement.docx)
• Click SAVE
• Make note of the Library Document ID (shows up in the document list, after you click SAVE)

Add a SigningHub Template:

• Dashboard > Quick Action > Templates
• Add a Template (blue plus sign)
• Upload a document (You can use example_app/ExampleAgreement.docx)
• Add a Placeholder Recipient (name and email will be pre-filled later)
• Click Next (top right)
• From the right sidebar, you can drag-and-drop form fields.
  • Drag-and-drop one Text field
  • Drag-and-drop one Electronic Signature field
  • Drag-and-drop one Date field
• Click on Done (top right)
• Make a note of the Template name

Configure the Example App

Copy the example settings to a local file:

cd ~/dev/signinghub_api/example_app
cp local_settings_example.py local_settings.py

Edit local_settings.py to reflect your SigningHub settings:

• SIGNINGHUB_CLIENT_ID must reflect the Application name created in the previous section.
• SIGNINGHUB_CLIENT_SECRET must reflect the Application API Key created in the previous section.
• SIGNINGHUB_LIBRARY_DOCUMENT_ID must reflect the Library Document ID created in the previous section.
• SIGNINGHUB_TEMPLATE_NAME must reflect the Template name created in the previous section.

Starting the web application

workon signinghub_api
cd ~/dev/signinghub_api
python runserver.py

You can now point your browser to: http://localhost:5000/

Prepare and Sign a Document

Click on 'Get new Access Token'

Click on 'Prepare and Sign Document'. This will perform this sequence:

• Add Package
• Upload Document from Library
• Rename Document
• Apply Workflow Template
• Get Document Fields
• Update Document Field
• Update Workflow User
• Share Document
• Display document in IFrame

After the user signs the document, SigningHub redirects to the configured Application API callback URL:

https://localhost:5000/signinghub/callback
    ?access_token=...
    &document_id=...
    &language=...
    &user_email=...

Previosly, the document_id could be stored in a persistent object, along with an 'UNSIGNED' status.

Here, the document_id query parameter can be used to retrieve that object and mark it as signed.

Javascript is used to close the IFrame window and render a page in the top window.

See also

• adobe_sign_api: https://github.com/lingthio/adobe_sign_api
• hellosign_api: https://github.com/lingthio/hellosign_api

Contributors

Ling Thio - ling.thio AT gmail.com

Did you find this useful? Consider tipping me or sending me a thank you email!