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

Plugin

Software modules that change how API calls behave, and which of them an account may use.

A plugin is a software module that changes how an API call behaves. Registering a tracker and generating a report both run through one: the plugin decides what extra parameters the call takes and what it does with them.

Which plugins an account may use varies, depending on platform settings and purchased features, and only those can be named in a call. This operation is how an integration finds out which it has.

Plugin object

The report plugins have their own page, report plugins, which documents the parameters each one takes.

API actions

API base path: /plugin.

Operations that list no errors of their own return only the general error codes.


List plugins

post
/plugin/list

List the plugins available to the current user.

Plugins are software modules that change how various API calls behave. Which ones are available varies by user, depending on platform settings and purchased features, and only these can be used to register trackers, generate reports and so on.

Callable with an empty body. Also accepts GET.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Responses
200

The available plugins

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/plugin/list
POST /v2/plugin/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "success": true,
  "list": [
    {
      "id": 1,
      "type": "text",
      "ui_module": "text",
      "module": "text",
      "filter": {
        "exclusion": true,
        "values": [
          "text"
        ]
      },
      "parameters": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Standalone-specific

When neither the user nor their telematics service provider (TSP) has any plugin enabled, the defaults apply instead, set by the plugin.tracker.register.defaultIds and plugin.tracker.report.defaultIds configuration options.

Last updated

Was this helpful?