Node.js Launcher Code Examples

This GitHub repo includes code example for both the DocuSign eSignature REST API as well as the DocuSign Rooms API. To use the Rooms API code example, modify the exampleAPI settings at the end of the appsettings.json file from eSignature to rooms.

Note: To use the Rooms API you must also create your DocuSign developer account for Rooms.

Github repo: code-examples-node

Introduction

This repo is a Node.js application that demonstrates:

eSignature API

1. Use embedded signing. Source. This example sends an envelope, and then uses embedded signing for the first signer. With embedded signing, the DocuSign signing is initiated from your website.
2. Send an envelope with a remote (email) signer and cc recipient. Source. The envelope includes a pdf, Word, and HTML document. Anchor text (AutoPlace) is used to position the signing fields in the documents.
3. List envelopes in the user's account. Source.
4. Get an envelope's basic information. Source. The example lists the basic information about an envelope, including its overall status.
5. List an envelope's recipients Source
   Includes current recipient status.
6. List an envelope's documents. Source
   This includes current recipient status.
7. Download an envelope's documents. Source
   The example can download individual documents, the documents concatenated together, or a zip file of the documents.
8. Programmatically create a template. Source
9. Send an envelope using a template. Source
10. Send an envelope and upload its documents with multpart binary transfer. [Source] (./lib/eSignature/eg010SendBinaryDocs.js)
    Binary transfer is 33% more efficient than using Base64 encoding.
11. Use embedded sending. Source. Embeds the DocuSign web tool (NDSE) in your web app to finalize or update the envelope and documents before they are sent.
12. Embedded DocuSign web tool (NDSE). Source.
13. Use embedded signing from a template with an added document. Source. This example sends an envelope based on a template. In addition to the template's document(s), the example adds an additional document to the envelope by using the Composite Templates feature.
14. Accept payments. Source
    Send an order form with online payment by credit card.
15. Get envelope tab data. Source
    Retrieve the tab (field) values for all of the envelope's recipients.
16. Set envelope tab values. Source
    The example creates an envelope and sets the initial values for its tabs (fields). Some of the tabs are set to be read-only, others can be updated by the recipient. The example also stores metadata with the envelope.
17. Set template tab values. Source
    The example creates an envelope using a template and sets the initial values for its tabs (fields). The example also stores metadata with the envelope.
18. Get the envelope custom field data (metadata). Source
    The example retrieves the custom metadata (custom data fields) stored with the envelope.
19. Requiring an access code for a Recipient Source
    This example sends and envelope that requires an access-code for the purpose of multi-factor authentication.
20. Requiring SMS authentication for a recipient Source
    This example sends and envelope that requires entering in a six digit code from an text message for the purpose of multi-factor authentication.
21. Requiring phone authentication for a recipient Source
    This example sends and envelope that requires entering in a voice-based response code for the purpose of multi-factor authentication.
22. Requiring knowledge-based authentication (KBA) for a Recipient Source
    This example sends and envelope that requires passing a public records check to validate identity for the purpose of multi-factor authentication.
23. Requiring ID Verification (IDV) for a recipient Source
    This example sends and envelope that requires the recipient to upload a government issued id.
24. Creating a permission profile Source
    This example demonstrates how to create a permission profile using the Create Permission Profile method.
25. Setting a permission profile Source
    This example demonstrates how to set a user group's permission profile using the Update Group method. You must have already created permissions profile and group of users.
26. Updating individual permission settings Source
    This example demonstrates how to edit individual permission settings on a permissions profile using the Update Permission Profile method.
27. Deleting a permission profile Source
    This example demonstrates how to delete a permission profile using the Delete Permission Profile method.
28. Creating a brand Source
    This example creates brand profile for an account using the Create Brand method.
29. Applying a brand to an envelope Source
    This example demonstrates how to apply a brand you've created to an envelope using the Create Envelope method. First, the code creates the envelope and then applies the brand to it. Anchor text (AutoPlace) is used to position the signing fields in the documents.
30. Applying a brand to a template Source
    This example demonstrates how to apply a brand you've created to a template using using the Create Envelope method. You must have at least one created template and brand. Anchor text (AutoPlace) is used to position the signing fields in the documents.
31. Bulk-send envelopes to multiple recipients Source
    This example demonstrates how to send envelopes in bulk to multiple recipients using these methods: Create Bulk Send List, Create Bulk Send Request. First, the code creates a bulk-send recipients list, and then creates an envelope. After that, initiates bulk envelope sending.

Rooms API

Note: To use the Rooms API, you must also create your DocuSign developer account for Rooms.

1. Create room with Data. Source
   This example creates a new room in your DocuSign Rooms account to be used for a transaction.
2. Create a room from a template. Source
   This example creates a new room using a template.
3. Create room with Data. Source. This example exports all the available data from a specific room in your DocuSign Rooms account.
4. Add forms to a room. Source. This example adds a standard real estate related form to a specific room in your DocuSign Rooms account.
5. How to search for rooms with filters. Source
   This example searches for rooms in your DocuSign Rooms account using a specific filter.
6. Create an external form fillable session. Source
   This example create an external form that can be filled using DocuSign for a specific room in your DocuSign Rooms account.

Authentication types:

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

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

Installation

Prerequisites

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

1. A DocuSign developer account (email and password) on demo.docusign.net. If you don't already have one, create a free account.

2. A DocuSign integration key (client ID). To use Authorization Code Grant, you will need an integration key and its secret key. To use JSON Web Token (JWT), you will need an integration key, an RSA key pair, and an account ID for the user you are impersonating.

   If you use this example on your own workstation, the Integration key must include a Redirect URI of http://localhost:5000/ds/callback

   If you will not be running the example on your own workstation, use the appropriate DNS name and port instead of localhost

3. Node.js version 8.10 or later with NPM version 5 or later.

4. A name and email for a signer, and a name and email for a cc recipient. The signer and the cc email cannot be the same.

Installation steps

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

1. Download or clone this repository to your workstation to directory code-examples-node
2. Switch to the folder: cd <Quickstart_folder_name> or cd code-examples-node
3. npm install
4. Copy the file config/appsettings.example.json into a file config/appsettings.json
   Either:
   • Update the file config/appsettings.json in the project's root directory with the Integration Key and other settings, or
   • Create and export environment variables for the settings. See the config/appsettings.json file for the names of the environment variables. Note: Protect your integration key and secret--If you update the config/appsettings.json file, then you should ensure that it will not be stored in your source code repository.
5. npm start
6. Open a browser to http://localhost:5000

Configuring JWT

1. Create a developer account on developers.docusign.com if you don't already have one.
2. Create a new API key in the Admin panel: https://admindemo.docusign.com/api-integrator-key, take note of the public key.
3. Set a redirect URI of http://localhost:5000/ds/callback as mentioned in the installation steps above for the integration key you create in Prerequisites item 2.
4. Generate an RSA key pair in the administrator console on the DocuSign developer account and copy the private key to a secure location.
5. Create a new file in your repo source folder named private.key, and paste in that copied RSA private key, then save it.
6. Update the file config/appsettings.json and include the newly created API key from item 2 as well as your account user id GUID which is also found on the Admin panel: https://admindemo.docusign.com/api-integrator-key.

From there you should be able to run the launcher using npm start then selecting JSON Web Token when authenticating your account.

Payments code example

To use the payments example, create a test payments gateway for your DocuSign developer account.

See the PAYMENTS_INSTALLATION.md file for instructions.

Then add the payment gateway account id to the config/appsettings.json file.

Unit Testing

1. Before running the unit tests you will need to obtain an Access Token and you will need an API Account ID.

2. Either:

   • Update the file test/testHelpers.js in the project's root directory with the Access Token, API Account ID, signer and cc information or
   • Create and export this information as the environment variables named in that file.

3. npm test

License and additional information

License

This repository uses the MIT License. See the LICENSE file for more information.

Pull Requests

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