For the complete documentation index, see llms.txt. This page is also available as Markdown.

Navixy Admin Panel API

What the Admin Panel API manages, its core concepts, and how to use this documentation.

The Admin Panel API (or Panel API for short) lets developers manage the Navixy platform at the dealer or reseller level: end-user accounts, devices, plans, and dealer-wide settings. Use it to build integrations and internal tools that automate administrative work instead of using the Admin Panel interface by hand.

The structure of the Admin Panel API mirrors that of the Platform API, so it helps to read that page first. The main differences are the authorization scheme and the request paths. Requests and responses use JSON over HTTPS.

Every operation is documented from a single OpenAPI specification, so each resource page under Resources carries the full parameter and response schema for its operations, along with a panel for sending a test request. Use those pages as the reference; this page orients you to the API as a whole.

Use the API to:

  • Provision and manage end-user accounts and their balances.

  • Register and clone devices, and move them between users.

  • Define and price service plans.

  • Issue activation codes so users can register devices themselves.

  • Brand the platform and configure service and notification settings.

  • Run sub-dealers that resell independently.

The API is built for developers and system integrators who manage a Navixy reseller deployment: automating dealer-level operations, building custom admin tooling, or provisioning users and devices at a scale the Admin Panel interface doesn't handle well by hand.

How to use this documentation

This section documents the Admin Panel API in full. Choose the path below depending on who, or what, is reading.

For developers

Start with Key concepts below to see how dealers, users, trackers, and plans fit together, then get access: Admin Panel authentication covers obtaining a session hash and, for shared or automated access, a technical service account.

Once you are authenticated, look up the operation you need in Resources. Each resource family page carries the full parameter and response schema, plus a panel for sending a test request. Errors covers the error code table shared with the Platform API, and API conventions covers the base URLs, data types, date and time format, and request rate limits shared with it.

For AI agents and LLMs

  • OpenAPI specification: the raw JSON specification for every endpoint, parameter, and schema. Every resource page renders it directly, so the parameter tables, response schemas, and status codes you see are generated from it rather than written by hand. Treat it as the technical source of truth.

  • Navixy docs via MCP: connect to query this documentation interactively instead of parsing static pages.

Key concepts

A dealer owns users directly, or indirectly through sub-dealers that resell on the dealer's behalf. Each user owns trackers, the devices registered to their account. Tariffs price a tracker's service, and orders record the equipment the dealer has purchased to supply those devices.

Term
What it is

Dealer

A reseller or distributor of the Navixy platform, with access to the Admin Panel to manage its users, devices, and service plans.

Sub-dealer (Sub PaaS)

A dealer operating underneath another dealer, called Sub PaaS in the interface and subpaas in API paths, with its own users, devices, and settings.

User

An end-user account that belongs to a dealer, either an organization or an individual, and can have sub-users that grant access to multiple employees.

Tracker

A device as presented to one owning user.

Clone

A second tracker sharing the same underlying device, so two users can see the same device independently.

Source

The underlying device behind a tracker and its clones. Several operations act on the source instead of on the tracker.

Order

An equipment order placed by the dealer.

Tariff (plan)

A service plan a dealer offers to its users, called a plan in the interface and returned as a Plan object in the API.

Tariff defaults

A dealer-level setting that determines which tariff a newly registered device lands on and what bonus and free period it receives. It is keyed by device type and separate from any individual tariff.

Activation code

A code tied to a specific tariff that lets a user register a device with the tariff, balance bonus, and free period already configured.

Session

A hash returned by authenticating, valid for 30 days from creation by default and not renewable. Admin Panel sessions are separate from Platform API sessions, so a hash from one can't be used with the other.

Technical service account

A reduced-privilege account created by Navixy support, used instead of personal credentials for shared or automated access.

See Admin Panel authentication for how to obtain and use a session hash, and Technical service accounts for the full comparison with full admin accounts.

Admin Panel API permissions

A permission is a pair of a category, for example trackers, and an operation, for example read. The API compares this pair against what the requested operation requires, and returns an "Operation not permitted" error on a mismatch.

Most Admin Panel API calls require a permission, but not all of them do: panel/account/auth and panel/timezone/list need no authentication and no permissions, and a few operations, such as account/get_permissions and account/logout, need only a valid session.

See Admin Panel permissions for the full list of categories and operations, and the get_permissions operation to check what a live session is allowed to do.

Next steps

For questions and support, contact the Navixy developer support team.

Last updated

Was this helpful?