Example 1: Ruby Service Integration

Repository: eg-01-ruby-jwt

Introduction

This software is an example of a System Integration. This type of application interacts with DocuSign on its own. There is no user interface and no user is present during normal operation.

The application uses the OAuth JWT grant flow to impersonate a user in the account.

This launcher example includes two examples:

1. Send an html, Word, and PDF file in an envelope to be signed.
2. List the envelopes in the account that are less than 30 days old.

Installation

Requirements: Ruby v2.1 or later

Download or clone this repository. Then:

cd eg-01-ruby-jwt
bundler install

# Create the config file
cp ds_config_EXAMPLE.rb ds_config.rb

Configure the example's settings

Update two files to configure the example:

1. Edit the ds_config.rb file in the root directory. (After creating it from the ds_config_EXAMPLE.rb file.) More information for the configuration settings is below.
2. Create the file docusign_private_key.txt in the root directory. Add the Integration Key's private key to the file in PEM format. When you download the private key from the DocuSign Admin Tool, it is already in the right format.

ds_config.rb and docusign_private_key.txt are in the .gitignore file so your private information will not be added to your repository.

Creating the Integration Key

Your DocuSign Integration Key must be configured for a JWT OAuth authentication flow:

• Create a public/private key pair for the key. Store the private key in a secure location. You can use a file or a key vault.
• The example requires the private key. Store the private key in the file docusign_private_key.txt. A future version of the SDK will remove the need to store the key in a file.
• If you will be using individual permission grants, you must create a Redirect URI for the key. Any URL can be used. By default, this example uses https://www.docusign.com

The impersonated user's guid

The JWT will impersonate a user within your account. The user can be an individual or a user representing a group such as "HR".

The example needs the guid assigned to the user. The guid value for each user in your account is available from the Administration tool in the Users section.

To see a user's guid, Edit the user's information. On the Edit User screen, the guid for the user is shown as the API Username.

Run the examples

ruby main.rb

Support, Contributions, License

Submit support questions to StackOverflow. Use tag docusignapi.

Contributions via Pull Requests are appreciated. All contributions must use the MIT License.

This repository uses the MIT license, see the LICENSE file.