https://github.com/signnow/signnownodesdk
The Official SignNow Node.js Client Library for interacting with SignNow REST API. Sign documents, request e-signatures, and build role-based workflows with multiple signers using this client.
https://github.com/signnow/signnownodesdk
api-client documents electronic-signatures esign esignature node npm package sdk signnow signnow-api
Last synced: 12 days ago
JSON representation
The Official SignNow Node.js Client Library for interacting with SignNow REST API. Sign documents, request e-signatures, and build role-based workflows with multiple signers using this client.
- Host: GitHub
- URL: https://github.com/signnow/signnownodesdk
- Owner: signnow
- License: mit
- Created: 2015-01-19T23:52:22.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-08-06T10:02:58.000Z (2 months ago)
- Last Synced: 2025-08-06T10:29:22.099Z (2 months ago)
- Topics: api-client, documents, electronic-signatures, esign, esignature, node, npm, package, sdk, signnow, signnow-api
- Language: TypeScript
- Homepage: https://www.signnow.com/developers
- Size: 4.42 MB
- Stars: 22
- Watchers: 8
- Forks: 22
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# signNow API NODE.JS SDK
## v3.0.0
[](https://nodejs.org/)
### Requirements
- Node.js 17 or higher
### Installation
Get SDK code
```bash
git clone git@github.com:signnow/SignNowNodeSDK.git
```
Install dependencies
```bash
npm install
```
### Configuration
Copy `.env.example` to `.env` and fill your credentials in the required values
```bash
cp .env.example .env
```
### Run tests
To run tests you need to have a valid `.env.test` file with credentials for testing.
If you don't have it, you can create it by copying the `.env.test.dist` file and renaming it to `.env.test`.
However, the file will be created automatically if you just run test execution with the following commands:
```bash
npm run test
```
### Usage
To start using the SDK, you need to create a new instance of the SDK API client and authenticate it using the credentials from the `.env` file.
Example of sending a request to get a document by id:
```typescript
import { Sdk, DocumentGet } from '@signnow/api-sdk';
import type { Document } from '@signnow/api-sdk';
const sdk = await new Sdk().authenticate();
const client = sdk.getClient();
const documentGet = new DocumentGet('29db9956636d481f9c532ef64951ae78209f7483');
const responseDocumentGet = await client.send(documentGet);
console.log('response document get', responseDocumentGet);
```
### Examples
You can find more examples of API usage in the [`examples`](./examples) directory.