HyperTrack Node Bindings
Node bindings for HyperTrack APIs.
Installation
npm install hypertrack-node --save
Usage
You'll need your HyperTrack secret key to initialize the client. You can find this from your account page on HyperTrack Dashboard. To get started -
- Initialize the client with secret key in your file:
var hypertrack = ;
- Start making API calls
hypertrackRESOURCE_NAMEMETHOD_NAME
Entities
The library supports all the following entities. Use the links to find a detailed list of possible API calls for each one of them.
Entity | Description | Method Access |
---|---|---|
User | Represents the person who is being tracked | hypertrack.users |
Action | Represents a transaction event (e.g., pickup, delivery, visit, appointment, drop-off) being performed by the User | hypertrack.actions |
Place | Represents a place of interest that an User may visit, or where an Action is expected | hypertrack.places |
Group | Represents a collection of Users | hypertrack.groups |
Event | An incident happens in the life of your users | hypertrack.events |
Geofence | Set a geofence to be notified when User enters or leaves certain place | hypertrack.geofence |
Every resource method returns a promise which can be used to chain multiple API calls as well as to catch any errors. For example, to create a user and assign action -
hypertrackusers;
Reference
For detailed documentation of the methods available, please visit the official HyperTrack API documentation.