docusign-esign

The Official DocuSign Node Client

NPM module that wraps the DocuSign API

Documentation about the DocuSign API

Documentation about this package

⚠️ The current release is the first version to use eSignature API v2.1. The GA version will be released soon.

All previous releases use eSignature API v2 and they no longer will be actively maintained.

Requirements

• Node 4
• Free Developer Sandbox

Compatibility

• Node 4+

Note:

This open-source SDK is provided for cases where you would like to make additional changes that the SDK does not provide out-of-the-box. If you simply want to use the SDK with any of the examples shown in the Developer Center, follow the installation instructions below.

Installation

NPM:

1. Open your preferred command-line console, then navigate to your project.
2. In the console, type the following commands:
   npm install docusign-esign -save

Dependencies

This client has the following external dependencies:

Minimum:

• DocuSign-eSign
• Superagent 3.8.2

Optional:

• Async v2.6.2
• Jsonwebtoken v8.2.0
• Passport-oauth2
• Path

Code Examples

Launchers

DocuSign provides a sample application referred to as a Launcher. The Launcher contains a set of 18 common use cases and associated source files. These examples use DocuSign's Authorization Code Grant flow.

Proof-of-concept applications

If your goal is to create a proof-of-concept application, DocuSign provides a set of Quick Start examples. The Quick Startexamples are meant to be used with DocuSign's OAuth Token Generator, which will allow you to generate tokens for the Demo/Sandbox environment only. These tokens last for eight hours and will enable you to build your proof-of-concept application without the need to fully implement an OAuth solution.

OAuth Implementations

For details regarding which type of OAuth grant will work best for your DocuSign integration, see the REST API Authentication Overview guide located on the DocuSign Developer Center.

For security purposes, DocuSign recommends using the Authorization Code Grant flow.

There are other use-case scenarios, such as single-page applications (SPA) that use Cross-Origin Resource Sharing (CORS), or where there may not be a user to interact with your Service Account. For these use cases, DocuSign also supports JWT and Implicit grants. For Ccode eExamples, see the links below:

• JWT (JSON Web Token)
• Implicit Grant (coming soon)

Support

Log issues against this client through GitHub. We also have an active developer community on Stack Overflow.

License

The DocuSign Node Client is licensed under the MIT License.