Guides and examples

Whole tasks worked end to end, with the calls in the order an integration makes them.

The reference tells you what one operation does. These guides tell you which operations to call, in what order, and why: getting a tracker's track points takes three calls, and a report is generated, retrieved once it is ready, then deleted.

Start with Getting list of GPS trackers if you are new to the API. Almost every other guide begins from a tracker ID.

Data retrieval

• Getting list of GPS trackers: the first call most integrations make, and where the other guides start.

• Getting track points: from a tracker to its trips, and from a trip to the raw points behind it.

• Retrieving sensor and counter data: reading what a device measured alongside its location.

• Obtaining report information: generating a report and collecting the result, which is asynchronous.

Device management

• Activate device: registering a GPS device or a mobile app on the Navixy platform.

• Sending commands to a GPS tracker via IP protocol (OTA): reconfiguring a device remotely instead of physically.

• Tracking stationary objects with BLE tags: using radio tags for objects that carry no device of their own.

Places

• Managing geofences: creating areas and using them to limit where a rule applies.

• Managing POIs: creating the client sites and depots that tasks are assigned against.

Rules and notifications

• Using rules: defining the conditions the platform watches for.

• Working with notifications: reading the events a rule logged, and how they are delivered.

• Receiving push notifications in your app: getting events to an app without polling for them.

Field service management

• How to create and assign tasks: the starting point, and what the other three build on.

• Changing employee statuses: recording what an employee is currently doing.

• Using task forms: collecting structured information when a task is completed.

• Working with check-ins: recording what an employee reported from a location.

Fleet management

• Managing vehicles and service works: the vehicle record, and the maintenance due against it.

• Using driver journals: categorising trips so transport use splits between business and private.

• Using tags: labelling across entity types so related things can be found together.

Raw IoT Data

• Requesting Raw IoT Data: reading unprocessed device data through the Raw IoT Data API, which has its own base URL and specification.