The Official DocuSign Rooms Node Client

[![NPM version][npm-image]][npm-url]
[![NPM downloads][downloads-image]][downloads-url]
[![Build status][travis-image]][travis-url]
[![Coverage Status][coveralls-image]][coveralls-url]

NPM module that wraps the DocuSign Rooms API

Documentation about the DocuSign Rooms API

Requirements

- Node 12
- Free Developer Account
- DocuSign Rooms account connected to your Developer account. Here is how to create a Rooms developer account

Compatibility

- Node 12+

Note:

This SDK will soon be provided as open-source 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-rooms -save

Dependencies

This client has the following external dependencies:

$3

- axios 1.6.8

$3

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

Code Examples

$3

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

OAuth Implementations

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

For security purposes, DocuSign recommends using the Authorization Code Grant or JWT 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 Code eExamples, see the links below:

Support

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

License

The DocuSign Rooms Node Client is licensed under the MIT License.

[npm-image]: https://img.shields.io/npm/v/docusign-rooms.svg?style=flat
[npm-url]: https://npmjs.org/package/docusign-rooms
[downloads-image]: https://img.shields.io/npm/dm/docusign-rooms.svg?style=flat
[downloads-url]: https://npmjs.org/package/docusign-rooms
[travis-image]: https://img.shields.io/travis/docusign/docusign-rooms-node-client.svg?style=flat
[travis-url]: https://travis-ci.org/docusign/docusign-node-client
[coveralls-image]: https://coveralls.io/repos/github/docusign/DocuSign-Node-Client/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/github/docusign/DocuSign-Node-Client?branch=master