Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cityssm/node-faster-unofficial-api
An unofficial API for the FASTER Web fleet management system, relying on exported reports and complex parsers.
https://github.com/cityssm/node-faster-unofficial-api
asset-management faster-web fleet-management fmis puppeteer
Last synced: 2 months ago
JSON representation
An unofficial API for the FASTER Web fleet management system, relying on exported reports and complex parsers.
- Host: GitHub
- URL: https://github.com/cityssm/node-faster-unofficial-api
- Owner: cityssm
- License: mit
- Created: 2024-09-27T14:59:07.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-14T09:03:10.000Z (2 months ago)
- Last Synced: 2024-10-14T15:21:45.123Z (2 months ago)
- Topics: asset-management, faster-web, fleet-management, fmis, puppeteer
- Language: TypeScript
- Homepage:
- Size: 285 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
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
# FASTER Web Unofficial API
[![npm (scoped)](https://img.shields.io/npm/v/%40cityssm/faster-unofficial-api)](https://www.npmjs.com/package/@cityssm/faster-unofficial-api)
[![DeepSource](https://app.deepsource.com/gh/cityssm/node-faster-unofficial-api.svg/?label=active+issues&show_trend=true&token=aTmjAZAV2qeEg4lTqqaxNKSD)](https://app.deepsource.com/gh/cityssm/node-faster-unofficial-api/)
[![Maintainability](https://api.codeclimate.com/v1/badges/0d91e0c07b4647f628e6/maintainability)](https://codeclimate.com/github/cityssm/node-faster-unofficial-api/maintainability)**An _unofficial_ API for the
[FASTER Web fleet management system](https://fasterasset.com/products/fleet-management-software/),
relying on exported reports and complex parsers.**This API ties together the following two projects:
- [FASTER Web Report Exporter - @cityssm/faster-web-exporter](https://www.npmjs.com/package/@cityssm/faster-report-exporter)
On demand exports of selected reports from the FASTER Web Fleet Management System.- [Faster Web Report Parser - @cityssm/faster-web-parser](https://www.npmjs.com/package/@cityssm/faster-report-parser)
Parses select Excel and CSV reports from the FASTER Web Fleet Management System into usable data objects.## Installation
```sh
npm install @cityssm/faster-unofficial-api
```## Usage
```javascript
import { FasterUnofficialAPI } from '@cityssm/faster-unofficial-api'const fasterApi = new FasterUnofficialAPI(
fasterTenant,
fasterUserName,
fasterPassword
)const assets = await fasterApi.getAssets()
const inventory = await fasterApi.getInventory()
```## More Code for FASTER Web
[FASTER Web Helper](https://github.com/cityssm/faster-web-helper)
A service to support integrations with the FASTER Web fleet management system.[Userscripts for FASTER Web](https://cityssm.github.io/userscripts/#userscripts-for-faster-web)
Fixes some of the common irks when using FASTER Web.
Includes userscripts to enforce field validation, correct varying header heights,
and offer autocomplete.