Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.54 KB

README.md

File metadata and controls

46 lines (30 loc) · 1.54 KB
Raw

Syncromatics Track API JavaScript Client

This is the JavaScript client for accessing the Syncromatics Track API.

Build Status semantic-release

Installation

npm install syncromatics-track-api

Quick start guide

import Track from 'syncromatics-track-api';

const api = new Track();
api.logIn({ apiKey: 'my API key' });

api.customer('SYNC').vehicles()
  .withQuery('012345')
  .getPage()
  .then(vehicles => /* work with vehicles */);

You can also log in with a username and password or a previously-generated JWT token. See the logIn documentation for details.

Documentation

Generated documentation is available on the project page. You can also find example usages in the src/examples directory.

Development

Versioning: npm version [0.0.xx-development] Publishing: npm publish

Contributing

Please see CONTRIBUTING for our guide to contributing and code of conduct.