DocuSign Integration

  • Updated
Follow

Please note that this is a premium feature which needs to be enabled by your dedicated customer success manager. For further information, please reach out to your BRYTER Customer Success Manager or support@bryter.io. Additional pricing may apply.

Admin Guide

Audience

Technical audiences with some knowledge of integration technologies who want to integrate BRYTER with DocuSign.

DocuSign integration vetting process

DocuSign does not allow direct integration with their production platform until the completion of a successful vetting process on a DocuSign sandbox system.
For more information, see DocuSign API documentation.

This process flow chart shows the steps in the integration process.

A process flow diagram outlining the steps required to vet an integration in the DocuSign sandbox environment.

Before you start

To create and access the keys used to integrate BRYTER with DocuSign, you will need to:

  1. Sign up for a DocuSign sandbox account.
    You can create and access the sandbox from the DocuSign Developer Page. Once you are inside the sandbox, you will need to create an app in Admin > Apps and Keys > Apps and Integration Keys > My Apps > Integration Keys.
    When the app is created, an integration key will be generated automatically.
  2. In the sandbox, navigate to Admin > Apps and Keys > Apps and Integration Keys > My Apps > Integration Keys and add https://bryter.io to the Redirect URIs field.
  3. Click the Save button.
  4. Ask your system administrator to create a DocuSign user account (with an email address) to use only for DocuSign messages (see the impersonated-user-guid parameter below).
    As this email address will receive large volumes of email messages from DocuSign, avoid using:
    - any personal email address such as john@example.com
    - any company address such as info@example.org

Configuration

One BRYTER integration configuration connects a single DocuSign user account. We recommend connecting user accounts with DS Sender permissions — not the default DS Admin permissions.

Parameters

Name

Description

Example Value
authentication-server Specifies which DocuSign environment to use. DO NOT include the https:// prefix account-d.docusign.com for the demo environment; account.docusign.com for the production environment
max-signers Maximum number of signers: a number from 1 to 50  
max-cc-fields Maximum number of CC inputs: a number from 1 to 50  
client-id Also known as the Integration Key, this value identifies the DocuSign integration app. Only one app integration key is required per configuration. You can find the value in Admin > Apps and Keys > Apps and Integration Keys > My Apps > Integration Keys. An app integration key may also be used for multiple configurations depending on whether you’re working with the demo or production environments.  
impersonated_user_guid This value identifies the DocuSign user account that sends the documents to be signed. You can find it in Admin > Users > (click on the relevant username) > API Username. db04e4e8-e59c-45c5-9b8e-ed409a

Secrets

Name

Description

Example Value
private-key

The private key for the integration to authenticate with DocuSign.

To obtain the private key you need to create an RSA key pair first in Admin > Apps and Keys > Apps and Integration Keys > Add App and Integration Key (or click on your app) > Authentication > Generate RSA.

It is very important to store your keys in a secure location such as a password manager as you won't be able to access them a second time.

Before pasting the private key in the appropriate input field, you must replace newlines with \\n characters.

A private key with replaced newlines will look like this:

-----BEGIN RSA PRIVATE KEY-----\\nMIIE...more private key content here...JlO3WKD==\\n-----END RSA PRIVATE KEY-----

Make sure the key doesn't have line breaks.

Please use online tools to REMOVE line breaks ( e.g. https://www.textfixer.com/tools/remove-line-breaks.php)

 

 

 

Related articles