Node.js Launcher Code Examples

GitHub repo: code-examples-node

This GitHub repo includes code examples for the DocuSign Admin API, Click API, eSignature REST API, Monitor API, and Rooms API. To switch between API code examples, modify the examplesApi setting in the appsettings.json file. Set only one API type to true and set the remaining to false.

If none of the API types are set to true, the DocuSign eSignature REST API code examples will be shown. If multiple API types are set to true, only the first will be shown.

Introduction

This repo is a Node.js application that supports the following authentication workflows:

• Authentication with DocuSign via Authorization Code Grant. When the token expires, the user is asked to re-authenticate. The refresh token is not used.

• Authentication with DocuSign via JSON Web Token (JWT) Grant. When the token expires, it updates automatically.

eSignature API

For more information about the scopes used for obtaining authorization to use the eSignature API, see Required scopes.

For a list of code examples that use the eSignature API, select the Node.js tab under Examples and languages on the DocuSign Developer Center.

Rooms API

Note: To use the Rooms API you must also create your Rooms developer account. Examples 4 and 6 require that you have the DocuSign Forms feature enabled in your Rooms for Real Estate account. For more information about the scopes used for obtaining authorization to use the Rooms API, see Required scopes.

For a list of code examples that use the Rooms API, select the Node.js tab under Examples and languages on the DocuSign Developer Center.

Click API

For more information about the scopes used for obtaining authorization to use the Click API, see Required scopes.

For a list of code examples that use the Click API, select the Node.js tab under Examples and languages on the DocuSign Developer Center.

Monitor API

Note: To use the Monitor API, you must also enable DocuSign Monitor for your organization. For information about the scopes used for obtaining authorization to use the Monitor API, see the scopes section.

For a list of code examples that use the Monitor API, select the Node.js tab under Examples and languages on the DocuSign Developer Center.

Admin API

Note: To use the Admin API, you must create an organization in your DocuSign developer account. Also, to run the DocuSign CLM code example, CLM must be enabled for your organization.

For more information about the scopes used for obtaining authorization to use the Admin API, see the scopes section.

For a list of code examples that use the Admin API, select the Node.js tab under Examples and languages on the DocuSign Developer Center.

Installation

Prerequisites

Note: If you downloaded this code using Quickstart from the DocuSign Developer Center, skip items 1 and 2 as they were automatically performed for you.

1. A free DocuSign developer account; create one if you don't already have one.

2. A DocuSign app and integration key that is configured to use either Authorization Code Grant or JWT Grant authentication.

   This video demonstrates how to obtain an integration key.

   To use Authorization Code Grant, you will need an integration key and a secret key. See Installation steps for details.

   To use JWT Grant, you will need an integration key, an RSA key pair, and the API Username GUID of the impersonated user. See Installation steps for JWT Grant authentication for details.

   For both authentication flows:

   If you use this launcher on your own workstation, the integration key must include redirect a URI of http://localhost:5000/ds/callback

   If you host this launcher on a remote web server, set your redirect URI as

   {base_url}/ds/callback

   where {base_url} is the URL for the web app.

3. Node.js 8.10 or later with npm 5 or later.

Installation steps

Note: If you downloaded this code using Quickstart from the DocuSign Developer Center, skip step 4 as it was automatically performed for you.

1. Extract the Quickstart ZIP file or download or clone the code-examples-node repository.
2. In your command-line environment, switch to the folder: cd <Quickstart folder> or cd code-examples-node
3. To install dependencies, run: npm install
4. To configure the launcher for Authorization Code Grant authentication, create a copy of the file config/appsettings.example.json and save the copy as config/appsettings.json.
   1. Add your integration key. On the Apps and Keys page, under Apps and Integration Keys, choose the app to use, then select Actions > Edit. Under General Info, copy the Integration Key GUID and save it in appsettings.json as your dsClientId.
   2. Generate a secret key, if you don’t already have one. Under Authentication, select + ADD SECRET KEY. Copy the secret key and save it in appsettings.json as your dsClientSecret.
   3. Add the launcher’s redirect URI. Under Additional settings, select + ADD URI, and set a redirect URI of http://localhost:5000/ds/callback. Select SAVE.
   4. Set a name and email address for the signer. In appsettings.json, save an email address as signerEmail and a name as signerName. Note: Protect your personal information. Please make sure that appsettings.json will not be stored in your source code repository.
5. Run the launcher: npm start
6. Open a browser to http://localhost:5000

Installation steps for JWT Grant authentication

Note: If you downloaded this code using Quickstart from the DocuSign Developer Center, skip step 4 as it was automatically performed for you. Also, in order to select JSON Web Token authentication in the launcher, in config/appsettings.json change the quickstart setting to "false".

1. Extract the Quickstart ZIP file or download or clone the code-examples-node repository.
2. In your command-line environment, switch to the folder: cd <Quickstart folder> or cd code-examples-node
3. To install dependencies, run: npm install
4. To configure the launcher for JWT Grant authentication, create a copy of the file config/appsettings.example.json and save the copy as config/appsettings.json.
   1. Add your API Username. On the Apps and Keys page, under My Account Information, copy the API Username GUID and save it in appsettings.json as your impersonatedUserGuid.
   2. Add your integration key. On the Apps and Keys page, under Apps and Integration Keys, choose the app to use, then select Actions > Edit. Under General Info, copy the Integration Key GUID and save it in apsettings.json as your dsClientId.
   3. Generate an RSA key pair, if you don’t already have one. Under Authentication, select + GENERATE RSA. Copy the private key, and save it in a new file named config/private.key.
   4. Add the launcher’s redirect URI. Under Additional settings, select + ADD URI, and set a redirect URI of http://localhost:5000/ds/callback. Select SAVE.
   5. Set a name and email address for the signer. In appsettings.json, save an email address as signerEmail and a name as signerName. Note: Protect your personal information. Please make sure that appsettings.json will not be stored in your source code repository.
5. Run the launcher: npm start
6. Open a browser to http://localhost:5000
7. On the black navigation bar, select Login.
8. From the picklist, select JWT (JSON Web Token) > Authenticate with DocuSign.
9. When prompted, log in to your DocuSign developer account. If this is your first time using the app, select ACCEPT at the consent window.
10. Select your desired code example.

Payments code example

To use the payments code example, create a test payment gateway on the Payments page in your developer account. See Configure a payment gateway for details.

Once you've created a payment gateway, save the Gateway Account ID GUID to appsettings.json.

License and additional information

License

This repository uses the MIT License. See LICENSE for details.

Pull Requests

Pull requests are welcomed. Pull requests will only be considered if their content uses the MIT License.