https://github.com/cityssm/node-consigno-cloud-api

An unofficial wrapper around the ConsignO Cloud API.
https://github.com/cityssm/node-consigno-cloud-api

consigno consigno-cloud digital-signature document-sign document-signature document-signing e-signature electronic-signatures pdf-signature pdf-signing

Last synced: 6 months ago
JSON representation

An unofficial wrapper around the ConsignO Cloud API.

• Host: GitHub
• URL: https://github.com/cityssm/node-consigno-cloud-api
• Owner: cityssm
• License: mit
• Created: 2025-07-21T15:15:02.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-09-18T15:42:48.000Z (10 months ago)
• Last Synced: 2025-10-21T09:37:58.591Z (9 months ago)
• Topics: consigno, consigno-cloud, digital-signature, document-sign, document-signature, document-signing, e-signature, electronic-signatures, pdf-signature, pdf-signing
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@cityssm/consigno-cloud-api
• Size: 635 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
# ConsignO Cloud API for Node

[![DeepSource](https://app.deepsource.com/gh/cityssm/node-consigno-cloud-api.svg/?label=active+issues&show_trend=true&token=g4HQMRMjtWEHNN2a7PwGpdjt)](https://app.deepsource.com/gh/cityssm/node-consigno-cloud-api/)

[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=cityssm_node-consigno-cloud-api&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=cityssm_node-consigno-cloud-api)

**An unofficial wrapper around the [ConsignO Cloud](https://consignocloud.com/) API.**

_Note that this project is not endorsed by Notarius._

💡 See the [ConsignO Cloud Basic API Documentation](https://support.notarius.com/wp-content/uploads/api/consigno-cloud-api-en.html) for more information.

## Installation

```bash

npm install @cityssm/consigno-cloud-api

```

## Usage

```javascript

import { ConsignoCloudAPI } from '@cityssm/consigno-cloud-api'

const api = new ConsignoCloudAPI({

  baseUrl: 'https://consigno.example.com/api/v1',

  apiKey: 't0p-secr3t-k3y',

  apiSecret: 'sup3r-secr3t-s3cret'

})

// Optionally impersonate a user

api.setLoginAs('clerk', '3rd-p@rty-app-p@ssw0rd')

// Get a workflow

const workflowData = await api.getWorkflow('workflowABC')

```

## Supported APIs

💡 Using this package in a Typescript environment is encouraged to help with complex function parameters.

- `getWorkflow(workflowId)`

- `createWorkflow(workflowDefinition)`

- `downloadDocuments(workflowId)`

- `downloadAuditTrail(workflowId)`

## Related Projects

**[PDF Puppeteer](https://www.npmjs.com/package/@cityssm/pdf-puppeteer)**


Converts URLs and HTML to PDFs using Puppeteer.

**[Sunrise Cemetery Management System (CMS)](https://github.com/cityssm/sunrise-cms)**


A completely free, open source, web-based application to assist cemetery managers with managing their cemetery records.

💡 Discover even more on [the City of Sault Ste. Marie's GitHub page](https://cityssm.github.io/).