https://github.com/docusign/docusign-rooms-node-client
The official Docusign Rooms Node client provides libraries for Node application integration with Docusign Rooms for real estate and mortgage workflows. It is recommended that you use this version of the library for new development.
https://github.com/docusign/docusign-rooms-node-client
Last synced: 12 months ago
JSON representation
The official Docusign Rooms Node client provides libraries for Node application integration with Docusign Rooms for real estate and mortgage workflows. It is recommended that you use this version of the library for new development.
- Host: GitHub
- URL: https://github.com/docusign/docusign-rooms-node-client
- Owner: docusign
- License: mit
- Created: 2020-10-30T03:09:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-27T06:49:16.000Z (over 1 year ago)
- Last Synced: 2025-03-25T18:45:28.836Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1.06 MB
- Stars: 2
- Watchers: 14
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://www.npmjs.com/package/docusign-rooms) that wraps the DocuSign Rooms API
[Documentation about the DocuSign Rooms API](https://developers.docusign.com/docs/rooms-api)
## Requirements
- Node 12
- Free [Developer Account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
- DocuSign Rooms account connected to your Developer account. [Here is how to create a Rooms developer account](https://developers.docusign.com/docs/rooms-api/rooms101/create-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](https://developers.docusign.com/docs/rooms-api/how-to/), 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:
### Minimum:
- axios 1.6.8
### 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](https://github.com/docusign/code-examples-node/). The Launcher contains a set of 6 common use cases and associated source files. These examples use DocuSign's [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/authcode-get-token/) flow.
## OAuth Implementations
For details regarding which type of OAuth grant will work best for your DocuSign integration, see the [Rooms API Authentication Overview](https://developers.docusign.com/docs/rooms-api/rooms101/auth/) guide located on the [DocuSign Developer Center](https://developers.docusign.com/).
For security purposes, DocuSign recommends using the [Authorization Code Grant](https://developers.docusign.com/platform/auth/authcode/authcode-get-token/) or [JWT](https://developers.docusign.com/platform/auth/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](https://developers.docusign.com/platform/auth/jwt/jwt-get-token/) and [Implicit](https://developers.docusign.com/platform/auth/implicit/implicit-get-token/) 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](http://stackoverflow.com/questions/tagged/docusignapi).
## License
The DocuSign Rooms Node Client is licensed under the [MIT License](https://github.com/docusign/docusign-rooms-node-client/blob/master/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