Skip to main content

Prepare Docusign connector

note

This connector is currently available in beta.

The Docusign connector retrieves information about users, user activity, and subscriptions. In Docusign, you are required to create an app, Secret Key, and Integration Key, generate a Refresh Token, and enter the values in Settings when adding the connector.

Prerequisites

You require an Admin user account, with the minimum Docusign API permissions. Your organization's Docusign plans can have multiple users in a single account based on the subscribed plan and pricing. All users fall under the same plan and pricing of the parent account. Currently, the available Docusign plans are:

  • eSignature plans and pricing:

    • Personal

    • Standard

    • Business Pro

  • Developer API plans and pricing

  • eSignature real estate plans and pricing

Procedure

  1. Sign in to your Docusign account, based on the subscription plan you have. https://account.docusign.com
tip

If you have a Docusign integration with Flexera One, you can use your existing Integration Key to add the connector in Snow Atlas, and skip to step 6 in the procedure.

  1. From your developer account, go to the Admin dashboard and from the menu on the left, select Apps and Keys.

  2. Select Add App and Integration Key.

  3. Enter a name for your app, and select Create App.

  4. In the app that you created:

    1. Under Authentication, select Authorization Code Grant (OAuth 2.0) as the authentication method.

    2. Select Add secret Key, then copy and save the secret key value from the field. This is used when adding the connector in Snow Atlas.

    3. Select Add URI and enter the redirect URI for your application as http://localhost.

    4. Select Save.

      In the page that appears, you will find the integration key for your created app under Apps and Integration Keys.

    5. Copy and save the value of the Integration Key. This will be used in the next steps and when adding the connector in Snow Atlas.

  5. Promote your Integration Key from your developer account to a production Docusign account according to Docusign's Go-live review process .

    note

    To qualify for and pass the Go-Live review, your app must meet all the requirements for going live for each API it uses. For details, see Go-live requirements page .

  6. Generate an authorization code for your app:

    1. Build an authorization URL in your browser with the sample URI below.

      BASE_URI/oauth/auth?
      response_type=code
      &scope=YOUR_REQUESTED_SCOPES
      &client_id=YOUR_INTEGRATION_KEY
      &state=YOUR_CUSTOM_STATE
      &redirect_uri=YOUR_REDIRECT_URI
      &login_hint=YOUR_LOGIN_EMAIL
      note

      The BASE_URI parameter must be changed depending on whether you are using the developer environment https://account-d.docusign.com or the production environment https://account.docusign.com in Docusign.

    2. Replace the parameters in the URL with the values below.

      ParameterValue
      YOUR_REQUESTED_SCOPESList of API scopes separated by space. You are required to add the scopes extended and signature for your app.
      YOUR_INTEGRATION_KEYThe value of the integration key that you saved in step 4.v.
      YOUR_CUSTOM_STATEOptional: Enter a unique and unguessable string. The state parameter is a security feature that mitigates the risk of the authorization flow being hijacked.
      YOUR_REDIRECT_URIThe redirect URI that you entered in step 5.iii.
      YOUR_LOGIN_EMAILOptional: Enter a login_hint to prepopulate the email address field on the sign-in screen.
    3. Enter the built URL in your browser. You are prompted to sign in to your account and give consent for your app to make calls on their behalf.

    4. Select Accept. You are redirected to the specified redirect_uri and the query parameter will include an authorization code.

    5. Copy and save the value of the code to use in the next step.

  7. Generate a refresh token using Postman:

    1. Encode the Integration key and Secret key into Base64 string format.

    2. Copy the resulting values into the Authorization header in Postman and make a POST request.

      The request will return the following:

      {
      "access_token": "ISSUED_ACCESS_TOKEN",
      "token_type": "Bearer",
      "refresh_token": "ISSUED_REFRESH_TOKEN",
      "expires_in": 28800
      }
    3. Copy and save the refresh_token value to use when adding the connector.

  8. When adding the connector in Snow Atlas, in Settings, enter the saved values in Integration Key, Secret Key, and Refresh Token.

After completing this task, follow the general procedure to Add connectors.

The connector makes API calls to the vendor and retrieves data. For more information, see API calls and Data retrieved by the connector.


Flexera does not own the third party trademarks, software, products, or tools (collectively, the "Third Party Products") referenced herein. Third Party Product updates, including user interface updates, may not be reflected in this content.