Skip to content

README.md

Latest commit

 

History

History
52 lines (36 loc) · 1.81 KB

README.md

File metadata and controls

52 lines (36 loc) · 1.81 KB

SignNow API Node.js SDK

v3.2.0

Node.js Version

Requirements

  • Node.js 17 or higher

Installation

Install the SDK from npm:

npm install @signnow/api-client

Usage

To start using the SDK, initialize the client with your credentials. You can authenticate using either an API key:

const sdk = new Sdk({ apiKey: '{{API_KEY}}' });

or by exchanging your Basic authorization token, username, and password for an access token:

const sdk = await new Sdk({ basicToken: '{{BASIC_TOKEN}}' }).authenticate(username, password);

Note: While the Basic authorization token is optional for requests authenticated via API key, it is required for:

  • Generating OAuth 2.0 access tokens.
  • Accessing specific endpoints, such as /api/v2/events.

For details on generating tokens and endpoint requirements, refer to the SignNow Authentication Guide.

Example of retrieving the document information by ID:

import { Sdk } from '@signnow/api-client/core/sdk';
import { DocumentGetRequest, DocumentGetResponse } from '@signnow/api-client/api/document';

const sdk = new Sdk({ apiKey: '{{API_KEY}}', basicToken: '{{BASIC_TOKEN}}' });
const client = sdk.getClient();

const documentGet = new DocumentGetRequest('1b23ed1a6aaf4d3392ed0e88bc2bfafb2a3cf414');
const responseDocumentGet = await client.send<DocumentGetResponse>(documentGet);
console.log('response document get', responseDocumentGet);

Examples

Find more API usage examples in the examples directory.