https://github.com/docusign/docusign-admin-node-client
The Docusign official Node.js Admin SDK
https://github.com/docusign/docusign-admin-node-client
Last synced: 2 months ago
JSON representation
The Docusign official Node.js Admin SDK
- Host: GitHub
- URL: https://github.com/docusign/docusign-admin-node-client
- Owner: docusign
- License: mit
- Created: 2021-08-26T21:29:50.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-30T15:26:40.000Z (over 1 year ago)
- Last Synced: 2025-04-11T22:51:32.027Z (12 months ago)
- Language: JavaScript
- Homepage: https://developers.docusign.com/docs/admin-api/
- Size: 872 KB
- Stars: 1
- Watchers: 16
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# The Official DocuSign Admin 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-admin) that wraps the DocuSign Admin API
[Documentation about the DocuSign Admin API](https://developers.docusign.com/docs/admin-api)
## Requirements
- Node 12
- Free [Developer Account](https://go.docusign.com/sandbox/productshot/?elqCampaignId=16531)
- DocuSign Admin account connected to your Developer account. [Here is how to create a developer account](https://go.docusign.com/o/sandbox/?ga=2.70927056.1363819232.1590515244-192278368.1546193875&ECID=20890&elqCampaignId=20890&LS=NA_DEV_BOTH_BetaSite_2020-05&utm_campaign=NA_DEV_BOTH_BetaSite_2020-05&Channel=DDCUS000016968056&cName=DocuSign.com&postActivateUrl=https://developers.docusign.com/)
## 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/admin-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-admin -save**
## Dependencies
This client has the following external dependencies:
### Minimum:
- axios 1.6.8
### Optional:
- Async v2.6.2
- Jsonwebtoken v9.0.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 [OrgAdmin API Authentication Overview](https://developers.docusign.com/docs/orgadmin-api/orgadmin101/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 Admin Node Client is licensed under the [MIT License](https://github.com/docusign/docusign-orgadmin-node-client/blob/master/LICENSE).
[npm-image]: https://img.shields.io/npm/v/docusign-admin.svg?style=flat
[npm-url]: https://npmjs.org/package/docusign-admin
[downloads-image]: https://img.shields.io/npm/dm/docusign-admin.svg?style=flat
[downloads-url]: https://npmjs.org/package/docusign-admin
[travis-image]: https://img.shields.io/travis/docusign/docusign-admin-node-client.svg?style=flat
[travis-url]: https://travis-ci.org/docusign/docusign-admin-node-client
[coveralls-image]: https://coveralls.io/repos/github/docusign/docusign-admin-node-client/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/github/docusign/docusign-admin-node-client?branch=master