Navixy Developer Documentation
The Navixy Platform API and Admin Panel API: what each one is for, how to tell which you need, and where to start.
Navixy, developed by SquareGPS, is a GPS and vehicle telematics platform. This documentation covers the Platform API and Admin Panel API: everything you need to query, control, and build on top of Navixy programmatically.
They are two separate APIs with separate credentials, and each has its own getting started guide. Pick the one that matches what you are building.
Which API do you need?
Both APIs are JSON over HTTPS, and both are documented from an OpenAPI specification. The dividing line is whose data you are acting on. The Platform API acts as a platform user, on that user's own account. The Admin Panel API acts as a dealer, on the accounts the dealer manages.
You are
a platform user, or an application acting for one
a dealer or reseller administering a deployment
It covers
the signed-in user's own account, sessions and settings, tracking (trackers, tracks, geofences, sensors, rules), fleet vehicles and maintenance, field service (tasks, places, employees), reports and tags, billing, and sub-users
dealer accounts, the end users beneath them, device registration and plans, activation codes, tariffs, sub-dealers, and panel branding and notification settings
You authenticate with
a user session hash, or an API key
a panel session hash
The two sets of credentials are not interchangeable. Both APIs send a credential in the Authorization header, and both name the scheme the same way. A hash issued by one is still rejected by the other. They also differ in what the header may carry, in whether a session can be renewed, and in how permissions work. Each API's authentication page is the only source for its own API: Platform authentication and Admin Panel authentication.
What both APIs share
Base URLs, data types, the date and time format, and request rate limits
The error response envelope and the error code table
Parameters in a JSON request body, also accepted form-encoded or as a query string
Request conventions for the Platform API, Using authentication in API requests for the Admin Panel
Everything else is documented per API, including authentication, and should not be assumed to carry across.
More APIs in the Navixy ecosystem
The Platform API and Admin Panel API cover the core of the Navixy platform. For specialized use cases, Navixy provides two additional API surfaces:
Configure and manage IoT Logic flows, write DSA scripts, use the Navixy expression language, and work directly with device-level behavior and protocols
GraphQL interface for managing geo-objects, assets, schedules, and device configuration at scale
Troubleshooting
Error codes: all error codes and their meanings are documented in Errors.
Session expired: re-authenticate to get a new hash. How long a session lasts, and whether it can be renewed, differs between the two APIs: see Platform authentication and Admin Panel authentication.
Too many requests: see Request rate limits.
Need help? Contact the Navixy developer support team via Contact Us.
Last updated
Was this helpful?