Skip to main content
Document management

DocuSign Integration Manual

Contact Express 8.1 (and higher) uses the DocuSign OAuth2 Authorisation Code Grant to authenticate. This requires each instance of Contract Express to have its own DocuSign integrator key. The steps required to set this up are described below.

Create and Set Up DocuSign Integrator Key (via DocuSign Demo Account)

The DocuSign Demo Account can be used for Contract Express test and production instances.

Generate Integrator Key

  1. Login to a DocuSign
    Demo
     Account via https://account-d.docusign.com using the DocuSign admin account.
  2. On the right-top of the open page, click on your
    Profile
    .
  3. Click
    Go to Admin
    .
  4. On the left-hand side menu, click on
    API and Key
     under INTEGRATIONS.
  5. Click
    ADD APP
     /
    INTEGRATOR KEY
    .
  6. In the pop-up window, add
    App Description
    (for example, Contract Express)
    .
  7. Click
    Edit
     under ACTIONS option at your created integrator key
    (for example, Contract Express)
    .
  8. In the pop-up window:
    1. Copy the value of
      Integrator Key
       (this will be used in the API web.config).
    2. Click ADD URL under Redirects URLs and specify Contract Express DocuSign call-back URL like https://<Contract Express the APP URL>/ESignature/Callback
      (for example, https://contractexpress.contoso.com/app/ESignature/Callback).
      note
      This is Case sensitive
    3. Click
      ADD SECRET KEY
       and take a note of that (this will be used in the API web.config).
      note
      When saved, this value no longer possible to view.
  9. Click
    Save
    .

Update the API web.config

  1. Update
    DocuSignClientId
     value with Integrator Key (generated earlier)
  2. Update
    DocuSignClientSecret
     value with Secret Key (generated earlier)
  3. Update
    DocuSignOAuthApiUrl
     value with DocuSign Demo OAuth API URL
    https://account-d.docusign.com
  4. Set
    DocuSignUseWebHook
     value to
    True
  5. Update
    ESignatureWebHookBaseUrl
     value with Contract Express DocuSign call-back URL like
    https://<Contract Express the API URL>
    (for example, https://contractexpress.contoso.com/rest)
    note
    This is Case sensitive

Activate DocuSign Feature

  1. Login to Contract Express application.
    note
    Make sure DocuSign feature is enabled (for more details, please see Configuring eSignature for a template)
  2. Open any generated contract with status
    Ready
     and click
    Start DocuSign
    .
  3. Use your DocuSign the user account
    credentials
     and
    accept
     DocuSign policies.

Promote DocuSign Integrator Key to DocuSign Production Account

In order to use DocuSign Production Account, the generated DocuSign Integrator Key shall be transferred in to DocuSign Production Account. If DocuSign Production Account is not required, skip this entire paragraph – otherwise, follow all configuration steps listed below.

Generate Successful DocuSign API Calls

  1. Login to Contract Express application.
    note
    Make sure DocuSign feature is configured as described in the above section
    Create and Setup DocuSign Integrator Key (via DocuSign Demo Account)
    .
  2. Complete
     any questionnaire 20 times (
    you should have 20 completed questionnaires with status Ready
    ).
  3. Go to each generated contract (
    see the step above
    ) a and click
    Start DocuSign
    .
  4. When DocuSign page opens, close that opened DocuSign page - repeat for each generated contract.
    Important
    : This step required that all 20 generated contracts opened that way with no errors. In case of an error, you need to repeat this step again for all 20 generated contracts.

Submit Successful DocuSign API Calls

  1. Login to a DocuSign
    Demo
     Account via https://account-d.docusign.com/ using DocuSign admin account.
  2. On the right-top of the open page, click on your
    Profile
    .
  3. Click
    Go to Admin
    .
  4. On the left-hand side menu, click on
    API and Key
     under INTEGRATIONS.
  5. Click
    Review Transactions
     under ACTIONS menu for previously created integrator key
    (i.e. Contract Express)
    .
  6. Select the current date.
  7. Click
    REVIEW
    .
    note
    Review may take up to 20 min to pass. If successful, Demo status will be replaced with Review Passed. If not successful, repeat the steps mentioned in above section
    Generate Successful DocuSign API Calls
    .

Move to DocuSign Production Account

  1. Login to a DocuSign
    Demo
     Account via https://account-d.docusign.com using DocuSign admin account.
  2. On the right-top of the open page, click on your
    Profile
    .
  3. Click
    Go to Admin
    .
  4. On the left-hand side menu, click on
    API and Key
     under INTEGRATIONS.
  5. Click
    Go Live
     under ACTIONS menu for previously created integrator key
    (i.e. Contract Express)
    .
  6. Accept
     DocuSign terms and conditions.
  7. Use DocuSign Production Account the admin account.
    note
    The integrator key transfer may take up to 24 hours to complete. A confirmation email should be received when transferred.

Configure Integrator Key

  1. Login to a DocuSign Production Account via https://account.docusign.com/ using DocuSign admin account .
  2. On the right-top of the open page, click on your Profile.
  3. Click Go to Admin.
  4. On the left-hand side menu, click on API and Key under INTEGRATIONS.
  5. Click Edit under ACTIONS menu for transferred integrator key (for example, Contoso International Ltd).
  6. In the pop-up window add App Description (for example, Contract Express).
  7. In the pop-up window:
    1. Copy the value of
      Integrator Key
       (this will be used in the API web.config).
    2. Click
      ADD URL
       under Redirects URLs and specify Contract Express DocuSign call-back URL like https://<Contract Express the APP URL>/ESignature/Callback
      (for example, https://contractexpress.contoso.com/app/ESignature/Callback).
      note
      This is Case sensitive.
    3. Click
      ADD SECRET KEY
       and take a note of that (this will be used in the API web.config).
      note
      When saved, this value no longer possible to view.
  8. Click
    Save
    .

Update the API web.config

  1. Update
    DocuSignClientId
     value with Integrator Key (generated earlier).
  2. Update
    DocuSignClientSecret
     value with Secret Key (generated earlier).
  3. Update
    DocuSignOAuthApiUrl
     value with DocuSign Demo OAuth API URL
    https://account-d.docusign.com
    .
  4. Set
    DocuSignUseWebHook
     value to
    True
    .
  5. Update
    ESignatureWebHookBaseUrl
     value with Contract Express DocuSign call-back URL like
    https://<Contract Express the API URL>
    (for example, https://contractexpress.contoso.com/rest)
    .
    note
    This is Case sensitive

Activate of DocuSign Feature

  1. Login to Contract Express application.
  2. Open any generated contract with status
    Ready
     and click
    Start DocuSign
    .
  3. Use your DocuSign the user account
    credentials
     and
    accept
     DocuSign policies.

This article applies to:

  • Product: Contract Express