ConsignO Cloud API for Node

An unofficial wrapper around the ConsignO Cloud API.

Note that this project is not endorsed by Notarius.

💡 See the ConsignO Cloud Basic API Documentation for more information.

Installation

npm install @cityssm/consigno-cloud-api

Usage

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
Converts URLs and HTML to PDFs using Puppeteer.

Sunrise Cemetery Management System (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.