DocuSign Integration

To use DocuSign in FireStart, you first need to create an application in DocuSign:

  1. Go to the DocuSign website and create a developer account. 

  2. On the dashboard, go to the Integrations section and click Apps and Keys.

  3. Click the Add App and Integration Key button to create an application for the integration.
  4. Define a name for the application.

  5. In the Authentication section, make sure the authentication option is set to Authorization Code Grant.

  6. In the Service Integration section, click the Generate RSA button. Copy Public and Private keys to a file.

  7. In the Additional settings section, click the Add URL button and add the following Redirect URL (you can use any other URL): https://www.firestart.com/

  8. Click Save.

  9. On the Apps and Keys dashboard, copy the Integration Key of the newly created application and User ID of your user.

To configure OAuth 2.0 authentication for DocuSign in FireStart, do the following:

  1. Open the FireStart Config Wizard as Admin User and open the External Services tab.

  2. Under DocuSign OAuth - Test Environment, enter the data of the application you created in the DocuSign developer account (see above).

    1. Client ID - Integration Key of the DocuSign application.

    2. User ID - User Id of DocuSign’s application. Can be found in Apps and Keys > My Account Information.

    3. Path to private key - absolute path to the file with the private key of the DocuSign application.

    4. Redirect URL- Redirect URL that will be used in consent link. This URL should be exactly the same as it was configured in DocuSign.

  3. Click Apply and then click the Give Consent button.

    1. The system will generate a consent link and a browser window will be opened.

    2. There will be an Allow Access button to give a DocuSign Consent for the newly created application.

  4. Close the FireStart Config Wizard.

  5. To make sure that consent was successfully given, use the following steps:

    1. In the DocuSign Dashboard, click on the icon of your user in the upper right corner and click the Manage Profile button.

       DocuSign 1-1
    2. On the My Profile page, select Connected Apps and make sure that the new application is displayed.

      DocuSign2-1
    3. You can revoke your consent any time using the Revoke button. If Consent is revoked, the application will not be able to get new JWT tokens. Old tokens might work for some time (expiration time of DocuSign’s JWT token is 1 hour).

For creating a DocuSign activity, see Miscellaneous Activities.

Verification

Before moving the application to Production, DocuSign requires to run at least 20 API test calls in the DocuSign development environment. To meet this requirement, generate 20 test envelopes using the DocuSign Activity.

Note: Only successful calls will be accepted by DocuSign and it may take some time for DocuSign to recognize them. You can track successful calls in the Apps and Keys dashboard

Once 20 test calls have been completed, click the Submit for review button or click the Actions button and select the Start Go-Live review option to begin the review process for the application. This may take up to 20 minutes for DocuSign to review. Make sure the application status is moved to Review pending.

To learn more about the Go Live process in DocuSign, see

Production

Once the application is approved by DocuSign, login to your Production account in DocuSign and complete the following steps:

  1. Generate RSA keys and copy them to a file as was done in Creating an application in DocuSign section.

  2. For the Production application, configure the redirect URL.

  3. Copy the User ID and Integration Key information.

  4. Open the FireStart Config Wizard, go to External Services > DocuSign OAuth Production Environment and populate all fields with the data from Production DocuSign environment:

    1. Client Id - Integration Key of the DocuSign Production application.

    2. User Id - User Id from Production DocuSign account.

    3. Path to private key - path to the private key of the application in DocuSign Production account.

    4. Redirect Url - Redirect Url that will be used in Consent link. This url should be exactly the same as was configured in DocuSign.

  5. Click Apply and then the Give Consent button.

  6. Give Consent for the application and Close the FireStart Config Wizard.

  7. Now you can open FireStart Client application and use Production mode in DocuSign Activity.

According to DocuSign’s recommendations, FireStart Server uses caching for User Information and access tokens:

favicon-32x32API usage guidelines

DocuSign User information for “User Id” is requested once per application restart.

Authentication tokens are cached, so for all DocuSign API requests, the FireStart server will reuse the existing authentication token if it is not expired. Expiration time of DocuSign authentication token is 1 hour.