@cityssm/avanti-api

Avanti API for Node

An unofficial wrapper around the Avanti API.

Note: At this time, this project focuses only on read-only endpoints, primarily on the api/v1/Reporter endpoint, and employee data related endpoints.

Installation

npm install @cityssm/avanti-api

Usage

⭐ See the Avanti API documentation on Authentication and Authorization for instructions on creating the needed credentials.

Note that each endpoint needs to be properly initialized in Avanti as well.

import { AvantiApi } from '@cityssm/avanti-api'

// Initialize the API
const avanti = new AvantiApi({
  base_api_url: 'https://myavanti.ca/avtesting-api',
  client_id: '',
  client_secret: '',
  username: '',
  password: '',
  company: ''
})

// Export report data
const report = await avanti.getReport('CUSTOM_REPORT_ID')

// Output the data
console.log(report)