FASTER Web Unofficial API

An unofficial API for the FASTER Web fleet management system relying on Puppeteer scripts, exported reports, and complex parsers.

This API prioritizes functions that are not available through FASTER-supported methods.

This API uses the following two projects:

• FASTER Web Report Exporter - @cityssm/faster-web-exporter
  On demand exports of selected reports from the FASTER Web Fleet Management System.

• FASTER Web Report Parser - @cityssm/faster-web-parser
  Parses select Excel and CSV reports from the FASTER Web Fleet Management System into usable data objects.

This unofficial API is in no way affiliated with or endorsed by FASTER Asset Solutions or Transit Technologies.

Installation

npm install @cityssm/faster-unofficial-api

Usage

⭐ This package requires a FASTER Web user name and password able to log into the FASTER Web application with permission to perform the function you need. For example, to execute an integration on demand using the executeIntegration() function, the provided user needs to have permission to do so.

import { FasterUnofficialAPI } from '@cityssm/faster-unofficial-api'

const fasterApi = new FasterUnofficialAPI(
  fasterTenant,
  fasterUserName,
  fasterPassword
)

const assets = await fasterApi.getAssets()

const inventory = await fasterApi.getInventory()

const itemUpdatedSuccessfully = await fasterApi.updateInventoryItem(
  itemNumber,
  storeroom,
  {
    itemName: 'New Item Name',
    itemDescription: 'Updated Item Description'
  }
)

const messageLog = await fasterApi.getMessageLog(startDate, endDate)

const executedSuccessfully = await fasterApi.executeIntegration(
  'Inventory Import Utility'
)

Related Projects

Building an intergration with FASTER Web?

Have a look at the City's open source projects related to FASTER Web.