Welcome to the Navixy API resources section. Here you'll find detailed information about all available resources.

Most modern GPS tracking devices can be reconfigured remotely using IP commands sent over-the-air (OTA). With the Navixy API, you can easily change device configurations or develop applications that allow users to send commands directly from the UI. These commands can also be integrated into automation rules, status changes, or parameter triggers, offering extensive flexibility and customization for managing your telematics solutions.

Sending a Command

To send a command to a device, you only need the following parameters:

• tracker_id: The ID of the device to which you want to send the command.

• command: The text or hexadecimal representation of the command in a protocol-dependent manner.

Example: Reconfiguring a Teltonika FMB140 Device

Suppose you have a Teltonika FMB140 device with an ID of 231402 on the platform, and you want to reconfigure its IP address to 52.57.1.136. According to the protocol, the command should be:

setparam 2004:52.57.1.136

API Request

To send this command, use the API request :

Upon successful execution, the platform will confirm that the command has been sent.

This method provides a reliable and efficient way to manage and control your GPS tracking devices via IP, ensuring seamless and real-time updates to device configurations.

The "Guides and Examples" section of the Navixy API documentation is designed to provide you with practical, step-by-step instructions for common tasks you can perform with the Navixy API. Whether you're managing devices, tracking data, setting up geofences, or handling notifications, these guides will help you make the most of the Navixy platform.

Device Management

• Learn how to activate a device on the Navixy platform to start tracking and monitoring.

Contains API call to get the last waybill number. Waybill number saved when new waybill had downloaded. If it had only digits, then it was incremented before saving.

API actions

API base path: track/waybill/settings/.

API actions

API base path: /tracker/contact

API actions

API base path: /tracker/datalogger.

upload

Employee statuses track the current activity of employees via their tracking devices. Examples include "busy" and "not busy." Each tracker can have a different status list assigned.

Create

To manage employee activities effectively, create working status lists and assign them to devices. For instance, a status list for a delivery service allows drivers and supervisors to change their working status using the X-GPS app or the UI.

To create a working status list, use the status/listing/create method. You need to provide the listing parameter, which is a status_listing object without the "id" and "entries" fields.

Example Request to Create a Working Status List

Example Response

Next, add individual working statuses to the list. For example, you might have the following statuses: "Free," "Break," "Pick up the goods from storage," and "Deliver goods."

Example Request to Add a Working Status

Example Response

Repeat the above request for each working status you need to add to the list.

Assign

To assign the working status list to devices, use the tracker_id and listing_id.

Example Request to Assign a Status List to a Tracker

Example Response

Usage

Once assigned, drivers and supervisors can change working statuses. Here are some use cases:

1. Automated Task Assignment: Create a script to assign a new task to a driver with the working status "Free." After assigning the task, the script changes the working status to "Pick up the goods from storage."

2. Task Completion: When a task is completed, a script changes the working status to "Free" and retrieves fields from the ERP system to create a new task and assign it to the driver.

This flexible system allows for efficient management of employee activities and can be integrated with various business processes for automation.

Push notifications enable your app to receive new events instantly without requiring continuous polling via API calls. These notifications can be leveraged to trigger actions such as updates to trackers, configurations, tasks, or even to send alerts to platforms like Telegram.

Whether your app is mobile or web-based, the subscription process for push notifications varies. Below, we outline the specific steps for each case.

Mobile Apps

The Navixy platform supports Firebase Cloud Messaging (FCM).

To get push notifications on mobile devices, follow these steps to obtain the app's push token:

1. Firebase projects support Google , which you can use to call Firebase server APIs from the app server. To authenticate a service account and authorize it to access Firebase services, you must .

2. Contact our support team at [email protected] with the generated private key, platform (Android/iOS), and your app's name.

3. We will provide you with the application ID for an API call to bind your app.

4. Obtain the push token of your app from Google Play Market or App Store.

5. Use the push_token/bind API call from your app. Substitute the push token and the application ID received from our support team.

Web Apps

To start receiving push notifications in your web application, follow these steps:

When creating a subscription, you must specify the . It should be in bytes, not as a base64 string.

Our public key in base64 is:

Here is a function example:

Take the endpoint and keys p256dh and auth from the pushSubscription object.

Example:

Use the push_token/bind API call with parameters:

• application=w3c_pushapi

• token=whole endpoint from pushSubscription, full URL like https://fcm.googleapis.com/fcm/send/f6kicrBn7S0:APA91b......

• parameters=object with keys from pushSubscription {"p256dh": "...", "auth":"..."}

You will receive the notification in event.data in JSON format.

Contains api call which link together trackers and working status lists.

API actions

API base path: /status/listing/tracker.

assign

Assigns a working status list (or remove assignment) to the tracker.

required sub-user rights: tracker_update.

Parameters

Examples

Response

Errors

• 201 - Not found in the database – if there is no tracker with such ID belonging to authorized user.

• 204 - Entity not found – if there is no working status list with such ID.

• 208 - Device blocked – if tracker exists but was blocked due to tariff restrictions or some other reason.

• 219 - Not allowed for clones of the device – if specified tracker is a clone.

API actions

API base path: /apn_settings.

read

Gets the APN name/user/password and mobile operator for registered device by phone number.

Parameters

Examples

Response

Errors

• 201 – The phone number not found in the database.

API actions

API path: /tracker/command/unconfirmed.

count

Gets number of commands in queue for the specified tracker.

Parameters

Examples

Response

• count - int. Number of unconfirmed commands in a queue.

Errors

• 204 – Entity not found - if there is no tracker with such ID belonging to authorized user.

• 208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

reset

Removes all pending SMS commands from the queue for the specified tracker.

required sub-user rights: tracker_update.

Parameters

Examples

Response

Errors

• 204 – Entity not found - if there is no tracker with such ID belonging to authorized user.

• 208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

API actions

API base path: /tracker/trusted_number.

list

Gets list of trusted numbers for the specified tracker.

Parameters

Examples

Response

• list - List of strings containing trusted phone numbers in the international format without "+" sign.

Errors

• 201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.

• 208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

update

Replaces the list of trusted numbers for a specified tracker with the new one.

required sub-user rights: tracker_update.

Parameters

Examples

cURL

Response

Errors

• 201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.

• 208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

This resource contains API call to get APN settings by tracker ID. APN is short of Access Point Name and provides a device with the information needed to connect to wireless service.

API actions

API base path: /tracker/apn_settings.

read

Gets the APN name/user/password and mobile operator of device by a tracker_id.

Parameters

Examples

Response

Errors

• 201 – Not found in the database - if tracker or APN settings not found.

• 208 – Device blocked.

• 214 – Requested operation not supported by the device - if the tracker does not have a GSM module or uses a bundled SIM card, the number of which is hidden from the user.

API actions

API base path: /tracker/stats/engine_hours.

read

Returns engine hours counted for the specified period.

Parameters

Examples

cURL

Response

Errors

• 204 – Entity not found - if there is no tracker with such ID belonging to authorized user.

• 208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

• 211 – Requested time span is too big - if interval between "from" and "to" is too big (maximum value specified in API config).

• 214 – Requested operation or parameters are not supported by the device - if device does not have ignition input.

API actions

API base path: /tracker/stats/mileage.

read

Returns mileage in kilometers in specified period grouped by trackers and day.

Parameters

Examples

cURL

Response

Errors

• 211 – Requested time span is too big - if interval between "from" and "to" is too big (maximum value specified in API config).

• 217 – List contains nonexistent entities.

• 221 – Device limit exceeded.

In many scenarios, it becomes essential to retrieve all location points of a track to gain comprehensive insights into the movements of an object equipped with a GPS tracker. This guide will demonstrate how to accomplish this using the Navixy API.

Prerequisites

Obtain API Key Hash

Rules are used to set up conditions according to which the system logs events and sends notifications to users.

When a server receives new data from a device, it checks whether the set conditions are true or false for this data. If they are true, the server generates an event in history, logs it, immediately sends an SMS, push message, or email, and saves the event in history.

Creating a Rule

To start working with rules, you must first create one. This involves setting up conditions under which the platform will generate events and scheduling intervals during which the rule should be active using the API call. The user must have access to rule updates.

API call to register a mobile application. Use with plugin_id 35.

API actions

API base path: /tracker/avatar.

upload

API calls to read the state of immobilizer and to set the new state. Engine immobilizer is an electronic security device fitted to a motor vehicle that prevents the engine from running unless it must run. This prevents the vehicle from being "hot wired" after entry has been achieved and thus reduces motor vehicle theft. This API call allows manipulating with immobilizer state.

API actions

API base path: /tracker/engine_immobilizer.

Specific portlets that are used for models of three device manufacturers:

• Engine event behavior for ATrack.

• Guard mode for Yatut.

• Harsh behavior for Suntech.

API calls to get and update LED state of the tracker. LED switch should be available for the device.

API actions

API base path: /tracker/led.

Contains API calls for reading and changing LBS settings. It is responsible for the LBS detection radius portlet in devices and settings tab in the UI. LBS (Location-based service) technology allows to determine the tracker's location without using standard location services such as GPS, GLONASS, Galileo or Beidou. LBS locates the position using cellular base stations or Wi-Fi access points.

API actions

API base path: /tracker/settings/lbs.

API actions

API path: /subscription.

/subscription/avangate/

Introduction

Welcome to the Navixy Backend API documentation. This guide is designed to help developers integrate third-party solutions with the Navixy platform. Here, you will find comprehensive information on API calls, workflows, and best practices.

Overview

The Navixy API provides a set of RESTful endpoints that allow you to interact with various entities such as geofences, rules, objects, and more. The API calls for CRUD and other operations with these entities follow a consistent naming convention, making it easier to understand and use.

Standard Workflow

To give you a clear idea of how to work with the Navixy API, let's go through a standard workflow using a common example – requesting track points data.

1. Determine the URL to API calls:

   • Depending on the physical location of the platform, the base URL will be:

     • https://api.eu.navixy.com/v2 for European Navixy platform;

API Base URL

Depending on the physical location of the platform, use one of the following base URLs:

• European Navixy platform:https://api.eu.navixy.com/v2

• North American Navixy platform:https://api.us.navixy.com/v2

• Self-hosted (On-Premise) installations:https://api.your_domain

For example, to make a user/auth API call on the European Navixy ServerMate platform, you should use the URLhttps://api.eu.navixy.com/v2/user/auth

API Calls Format

API calls follow a consistent notation: /resource/sub_resource/action(parameter1, parameter2, [parameter3])

Parameters can be passed in different ways:

• HTTP POST application/json: Recommended

• HTTP POST application/x-www-form-urlencoded: Parameters in the request body

• HTTP GET: Not recommended, should be used only for idempotent requests with small parameter size

Examples

HTTP POST application/json

HTTP POST application/x-www-form-urlencoded

HTTP GET

Request and Response Format

To make an API call, send a POST request to:[api_base_url]/resource/action/

The response will be given with application/json content type, even for errors. Response fields and object structure are specific to the API call.

Ensuring Compatibility

Our API evolves over time, and new methods and JSON object fields are added. We strive to maintain backward compatibility with legacy API clients. However, you must ensure that any unsupported JSON object fields by your app are ignored, and that your application can handle new JSON fields without breaking. Also, to reduce response size, JSON fields that are NULL are omitted. Your JSON parser should handle missing JSON fields as if they were NULL.

Authorization and Access Levels

Unless otherwise noted, every API call requires a valid API Key hash. This hash can be passed in one of the following ways:

1. As a hash parameter of the request body (root-level property for application/json).

2. As a hash parameter of the HTTP query string.

3. As a value of the HTTP header

Data Types

String Validation Rules

This validation ensures that the provided string adheres to specific content rules. The rules may vary depending on the particular field being validated. The string is checked for the following criteria:

• Empty strings or null values: may be allowed or restricted depending on the specific field.

• Character types:

  • Regular spaces are always allowed (Unicode category "Zs").

  • Other whitespace characters (tabs, line breaks, etc.): may be allowed or restricted depending on the specific field.

Date/Time Formats

Date/time type can be represented with the following formats:

• yyyy-MM-dd HH:mm:ss format (in user's timezone), default

• yyyy-MM-dd'T'HH:mm:ssZZ

To use ISO 8601 date/time format, pass true to:

1. iso_datetime parameter of the request body (root-level property for application/json).

2. iso_datetime parameter of the HTTP query string.

3. HTTP header NVX-ISO-DateTime.

Example

JSON request body parameter

Form request parameter

HTTP Header

Response Example with Fixed Offset Date/Time

Response Example with UTC Date/Time

Next Steps

• : Learn how to authenticate and obtain a user key

• : Understand how to handle errors in the Navixy API

Notifications are a crucial part of tracking. A created rule tracks the triggering of specified conditions and sends events to emails and phones. Notifications alert users when a condition is triggered. Sometimes, it is necessary to store these notifications and history entries for special reports or for use in scripts built on APIs. This guide will show you how to work with them using the Navixy API.

Obtain a List of History Entries

All Unread Events of a User

Use the call to get all unread events.

This call contains only two optional parameters:

• limit: An integer specifying the maximum count of entries in the response.

• from: A string containing the start for the search. Without this parameter, you will get all unread entries for the last 30 days.

Example: To obtain no more than 100 entries for the last month (assuming today's date is 2021-01-26), the API request will be:

The response will contain a list of history entries with that can be used for various purposes:

Events for Specific Trackers and Time Period

Use the call to get all events for specific trackers over a specified time period. This call can also return specific event types sorted by time if necessary.

Required Parameters

• trackers: An array of integers. A for which events will be searched.

• from: A string containing the start for the search.

• to: A string containing the end for the search. Must be after the from date.

Optional Parameters

• events: An array of strings with the necessary event types. All other events will be ignored. Default is all. To get a list of events, use the call.

• limit: An integer specifying the maximum count of entries in the result.

• ascending: A boolean that sorts the results in ascending order by time when true and descending when false

Example: To obtain no more than 100 entries for December for one device, sorted in descending order by time, and to know only when the device entered and exited the geofence, the API request will be:

The response will contain the that match the request.

All Events of a User for a Specific Time Period

To obtain a list of all tracker events for a user received between the specified "from" and "to" dates, use the method. You can also filter the results to include only the necessary event types.

Required Parameters

• from: A string containing the start for the search.

• to: A string containing the end for the search. Must be after the from date.

Optional Parameters

• events: An array of strings with the necessary event types. All other events will be ignored. Default is all. To get a list of events, use the call.

• limit: An integer specifying the maximum number of entries in the result.

• ascending: A boolean that sorts the results in ascending order by time when true and descending when false

Example: To get state field events for the last five minutes on all trackers of a user, use to=CURRTIME and from=CURRTIME-5 minutes. Filter by state_field_control events.

The response will contain the that match the request.

In the Navixy API, the vehicle object stores comprehensive information about a vehicle, such as its VIN, chassis number, license plate, type, dimensions, load capacity, fuel consumption, insurance details, and more. You can link a vehicle to a tracker to monitor various parameters like fuel consumption per trip and schedule timely maintenance based on mileage or engine hours.

Service works are crucial for cost and risk management in vehicle maintenance. Regular maintenance helps prevent breakdowns, ensuring vehicles remain operational and safe. For example, replacing spare parts based on usage, scheduling tire replacements, and ordering necessary parts in advance can prevent delays and reduce the risk of cargo loss.

Vehicle Creation

To create a vehicle object, specify all relevant information about the vehicle. You can link the vehicle to a tracker by providing its ID in the tracker_id parameter.

Example

Creating a Ford Transit cargo van vehicle object:

The platform will respond with:

Service Work Creation

After creating a vehicle object and assigning a device, you can create service works to manage vehicle maintenance. Each service work represents a specific maintenance task with conditions based on mileage or engine hours.

Example

Creating service works for oil change, brakes replacement, and spark plug replacement.

Oil Change

Brakes Replacement

The platform will respond with the ID of the created service work:

API call for getting the route to destination point using OSRM API.

API actions

API path: /route/osrm.

get

Gets route points via OSRM API.

Parameters

Where location described in .

Examples

cURL

Response

• distance - int. Length in meters.

• time - int. Duration in seconds.

• list - list of route points. Location objects.

Errors

• 215 - External service error.

• 218 - Malformed external service parameters.

• 236 - Feature unavailable due to tariff restrictions – if there is at least one tracker without "routing" tariff feature.

Allows assigning employee ("driver") to a device. Also, read who is on a vehicle now, hardware key and when, where it was assigned.

API actions

API base path: /tracker/employee.

assign

Assigns another employee ("driver") to the tracker.

required sub-user rights: employee_update.required tariff feature: app_fleet.

Parameters

Examples

Response

Errors

• 201 – Not found in the database - if there is no tracker or employee with such ID belonging to authorized user.

• 208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

• 263 – No change needed, old and new values are the same - if new employee matches a currently assigned employee.

read

Requests to read the current employee (driver) assigned to tracker, and when it was assigned.

Parameters

Examples

Response

• current - current employee (driver) info, standard employee object, can be null.

• last_change - information about the employee's last assignment, can be null.

  • old_employee_id

Errors

• 201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.

• 208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

Geofences are virtual perimeters for real geographic areas. The Navixy platform can monitor whether an object equipped with a GPS tracker crosses a geofence border (either entering or exiting). All such events are logged, enabling users to obtain geofence reports and receive alerts. Furthermore, various rules can be assigned to events related to specific geofences. For instance, you might want to receive speeding alerts only within a certain area, such as a city or along a specific route.

Geofence Creation

To create a geofence, use the zone/create API call. There are several types of geofences, and the creation process varies between them.

Circle Geofence

The simplest geofence to create is the circle geofence, which requires only a center point and a radius. The platform will automatically calculate the borders.

For example, to create a geofence with a 50-meter radius around a business park to track employees, you can use the following API request. This geofence can trigger alerts when employees arrive at or leave work.

API Request:

The platform will respond with the status and the created geofence ID. This ID can be used to .

Polygon Geofence

A polygon geofence is more complex as it requires specifying multiple points where the geofence border changes direction. The maximum number of points is 100 to maintain computational efficiency. For example, to track the maximum speed of vehicles within Rome, you can create a geofence that covers the city.

API Request:

The platform will respond with the geofence ID. Follow the to create rules.

Corridor Geofence

Corridor geofences are used for roads. They need to be accurate, and their calculated area is not as computationally intensive as polygons. Therefore, the maximum number of points is 1024.

For example, to create geofences for street cleaning vehicles to ensure they follow the correct route, you can use the following API request with the sausage parameter in it:

API Request:

The platform will provide the status and geofence ID.

Corridor geofences can also be used to create special routes for vehicles carrying valuable cargo, such as cash collectors, or for patrol cars. In such cases, use the rule "deviation from the route."

Getting Geofence Name by a Tracker's Location

To get the geofence name or ID where a device is located, use the API call. For example, to determine which geofence a device is in or to count how many devices are in a specific zone, first request the device's . With the received latitude and longitude parameters, you can then check the geofences.

API actions

API base path: /tracker/alarm_mode.

read

Gets the state of alarm mode of device.

Parameters

Examples

Response

• enabled - true if alarm mode enabled.

Errors

• 204 – Entity not found - if there is no tracker with such ID belonging to authorized user.

• 208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

• 214 – Requested operation or parameters are not supported by the device - if device does not support alarm mode.

set

Changes the state of alarm mode of device. The device must be online.

Parameters

Examples

Response

Errors

• 204 – Entity not found - if there is no tracker with such ID belonging to authorized user.

• 208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

• 213 – Cannot perform action: the device is offline - if corresponding tracker is not connected to the server.

• 214 – Requested operation or parameters are not supported by the device - if device does not support alarm mode.

API call for getting the route to destination point.

API actions

API path: /route.

get

Gets route points via specified route provider.

Parameters

• location object described in .

Example

cURL

Response

• distance - int. Length in meters.

• time - int. Duration in seconds.

• list - list of route points. Location objects.

Errors

• 215 - External service error.

• 218 - Malformed external service parameters.

• 236 - Feature unavailable due to tariff restrictions – if there is at least one tracker without "routing" tariff feature.

API actions

API base path: /tracker/settings.

read

Gets base settings for the specified tracker.

Parameters

Examples

Response

• label - string. User-defined label for this tracker, e.g. "Courier".

• group_id - int. Tracker group id. 0 if tracker does not belong to any group.

Errors

• 201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.

• 208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

update

Updates the settings of the specified tracker.

required sub-user rights: tracker_update.

Parameters

Examples

Response

Errors

• 201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.

• 208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

• 204 – Entity not found - if there is no group with the specified group id.

Contains tracker retranslator binding object and API calls to bind/unbind it to tracker or get already binded one.

Tracker retranslator binding object

• retranslator_id - int. An ID of the retranslator.

• fake_device_id - string. Optional. If this field is set retranslator use it instead of real device ID to forward data.

API actions

API base path: /tracker/retranslator.

bind

Creates or updates binding.

required sub-user rights: admin (available only to master users).

Parameters

Examples

Response

Errors

• 201 - Not found - either tracker or retranslator are not found by provided ID

• 208 - Device blocked – if tracker exists but was blocked due to tariff restrictions or some other reason.

• 219 - Not allowed for clones of the device – if tracker is a clone.

• 236 - Feature unavailable due to tariff restrictions – if there are no trackers with "retranslation" tariff feature available.

list

List tracker retranslators bound to tracker with ID=tracker_id.

Parameters

Examples

Response

Errors

• 208 - Device blocked – if tracker exists but was blocked due to tariff restrictions, or some other reason.

unbind

Unbinds a tracker from retranslator.

required sub-user rights: admin (available only to master users).

Parameters

Examples

Response

Errors

• 208 - Device blocked – if tracker exists but was blocked due to tariff restrictions, or some other reason.

• 219 - Not allowed for clones of the device – if tracker is a clone.

API calls for reading and setting data transmission and operating modes of devices. It is responsible for the tracking mode portlet in devices and settings tab in the UI. The list of settings can vary depending on model of the used tracker, the principle of its work and its functionality.

API actions

API base path: /tracker/settings/tracking.

read

Gets tracking settings for the specified tracker.

Parameters

Examples

Response

Returned fields may differ from model to model. See tracking profiles for more information.

Errors

• 201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.

• 208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

• 214 – Requested operation or parameters are not supported by the device - if device model has no tracking settings at all.

update

Sends new tracking settings to the specified tracker.

required sub-user rights: tracker_configure.

Parameters

Examples

cURL

Response

Returned fields may differ from model to model. See tracking profiles for more information.

Errors

• 201 – Not found in the database - if there is no tracker with such ID belonging to authorized user.

• 208 – Device blocked - if tracker exists but was blocked due to tariff restrictions or some other reason.

• 214 – Requested operation or parameters are not supported by the device - if device model has no tracking settings at all.

• 219 – Not allowed for clones of the device - if specified tracker is clone of another tracker.

All actions to retrieve and manipulate points of the geofence. Note that circle geofence type can't have points.

Point object structure

• lat - float. Point latitude.

• lng - float. Point latitude.

• node - boolean. Will be true if this point is a route node.

API actions

API base path: /zone/point.

list

Get points of user's geofence with zone_id.

Parameters

Examples

Response

• list - array of objects. List of point objects.

Errors

• 201 - Not found in the database – if geofence with the specified ID cannot be found or belongs to another user.

• 230 - Not supported for this entity type – if geofence cannot have any points associated with it (e.g. if geofence is circle).

update

Update points for user's geofence with zone_id.

required sub-user rights: zone_update.

Parameters

Example

cURL

Response

Errors

• 201 - Not found in the database – if geofence with the specified ID cannot be found or belongs to another user.

• 202 - Too many points in a geofence – if "points" array size exceeds limit for this geofence type. Max allowed points count for a geofence is 500 for a polygon or 1024 for a sausage.

• 230 - Not supported for this entity type – if geofence cannot have any points associated with it (e.g., if geofence is circle).

• 284 - Not enough points for the zone. The minimum number of points for polygon: 3; the minimum for sausage: 2.

This guide describes how to obtain a list of GPS devices linked to a user account via the Navixy API. Accessing this information is fundamental for efficiently managing and monitoring multiple devices in the Navixy system.

Prerequisites

Before you begin, make sure you have an active Navixy account and a valid . This key is required to access the API and perform authorized requests within the system.

Contains map layer object structure and API calls to interact with it.

Map layer object structure:

• id - int. Map layer entity ID.

API call for getting the route to destination point using .

API actions

API path: /route/google.

API calls for output control. Some device models work with set_all and some with set calls.

API actions

API base path: /tracker/output.

API actions

API path: /track/waybill.

download

Bill object

• order_id - int. Unique bill ID.

• created

Contains API calls for getting and changing parking detection for the tracker. It is responsible for the parking detection function in the UI. The monitoring system automatically detects the facts of parking (states without movement), for the following purposes:

• To split a movement trajectory to separate trips - for clear illustration and easy viewing in tabular reports;

• To capture "Trip end" / "Trip start" events - with possibility of Email/SMS notification.

Driver Journals log all trips made by an employee within a selected period, categorizing them by status: business, private, or other. Users can view a summary of all trips, highlighting their statuses, or filter to show only specific types. This data can be exported as PDF/Excel files or printed directly.

Driver Journals provide detailed trip information, including mileage, location, date, and time, enabling clients to differentiate between business and personal miles accurately. This helps in deducting business-related expenses. For ambiguous cases, trips can be marked as "other" and later reviewed for proper categorization.

All trip data is securely stored digitally, eliminating the need for physical paperwork. However, supporting receipts for expenses like fuel should be kept for verification.

For example, to generate a bill for fuel payment, you may need to categorize all trips of a device for the previous day. These records include important trip details such as driver, start/end dates, locations, trip length, and odometer readings, which can be used in your CRM.

API actions

API base path: /delivery.

read

API call for getting the route to destination point using .

API actions

API path: /route/progorod.

Payment system settings object

• type - string. Payment system type.