Ctrlk
Log inGet startedAsk Navixy AI
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Retranslator

Forward the data a device sends to the Navixy platform on to a third-party server.

A retranslator forwards the data that a device sends to the platform on to a third-party server of the user's choosing, so the same stream can feed an outside application without touching the device.

Each retranslator names a protocol, the address and port of the receiving server, and whether it is currently enabled. Some protocols also require a login and a password. Which ones do is decided by the protocol, so call retranslator/protocols/list before creating a retranslator and read the credential rules it reports.

Every operation that changes a retranslator requires the admin right, which is available only to master users. Listing them and listing the protocols are not restricted.

Retranslator protocol object

Retranslator object

API actions

API base path: /retranslator.

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

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

Create retranslator

post
/retranslator/create

Create a retranslator, which forwards the data a device sends to the platform on to a third-party server.

Pass the retranslator object without id.

Address, port and login must be unique within the account; a duplicate returns error 247. Which of login and password are required depends on the protocol: read required_login and required_password from retranslator/protocols/list before saving one. A missing required value returns error 7 naming the field.

Requires the admin right, so only a master user can call it.

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.

Body
Responses
200

The created retranslator

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
idintegerOptional

ID of the new retranslator.

post/retranslator/create
POST /v2/retranslator/create HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "retranslator": {
    "id": 1,
    "name": "text",
    "protocol_id": 1,
    "address": "text",
    "port": 1,
    "login": "text",
    "password": "text",
    "enabled": true
  }
}
{
  "success": true,
  "id": 1
}

Errors

These errors come in addition to the general error codes:

  • 7 - Invalid parameters, when the protocol requires a login or a password and the field was sent empty.

  • 206 - Login already in use. For the Navixy Web Service protocol, another retranslator on the platform already uses this login.

  • 247 - Entity already exists, when a retranslator with this address, port, and login already exists.

  • 268 - Over quota, when the user's quota for retranslators is exceeded.

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

Delete retranslator

post
/retranslator/delete

Delete a retranslator. Devices forwarding through it stop doing so.

Requires the admin right, so only a master user can call it.

Also accepts GET with the same parameters as query-string values.

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.

Body
retranslator_idinteger · min: 1Required

ID of the retranslator to delete.

Responses
200

Retranslator deleted

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/retranslator/delete
POST /v2/retranslator/delete HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "retranslator_id": 1
}
{
  "success": true
}

Errors

These errors come in addition to the general error codes:

  • 201 - Not found in the database.

List retranslators

post
/retranslator/list

Return every retranslator belonging to the account.

The response includes each retranslator's password in clear text.

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.

Body
objectOptional
Responses
200

The retranslators

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/retranslator/list
POST /v2/retranslator/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "success": true,
  "list": [
    {
      "id": 1,
      "name": "text",
      "protocol_id": 1,
      "address": "text",
      "port": 1,
      "login": "text",
      "password": "text",
      "enabled": true
    }
  ]
}

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

Update retranslator

post
/retranslator/update

Update a retranslator. It must exist and belong to the current account.

id is required inside the object and identifies which retranslator to change. Every other field is replaced by what is sent.

Address, port and login must be unique within the account; a duplicate returns error 247. Which of login and password are required depends on the protocol: read required_login and required_password from retranslator/protocols/list before saving one. A missing required value returns error 7 naming the field.

Requires the admin right, so only a master user can call it.

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.

Body
Responses
200

Retranslator updated

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/retranslator/update
POST /v2/retranslator/update HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "retranslator": {
    "id": 1,
    "name": "text",
    "protocol_id": 1,
    "address": "text",
    "port": 1,
    "login": "text",
    "password": "text",
    "enabled": true
  }
}
{
  "success": true
}

Errors

These errors come in addition to the general error codes:

  • 7 - Invalid parameters, when the protocol requires a login or a password and the field was sent empty.

  • 201 - Not found in the database, when no retranslator has the given ID or it belongs to another user.

  • 206 - Login already in use. For the Navixy Web Service protocol, another retranslator on the platform already uses this login.

  • 247 - Entity already exists, when a retranslator with this address, port, and login already exists.

List retranslator protocols

post
/retranslator/protocols/list

Return every retranslator protocol the platform supports, with the credential rules each one imposes.

Read this before creating a retranslator: required_login and required_password decide which credentials the create call will insist on, and fake_device_id_pattern constrains the substitute device ID.

Callable with an empty body. Also accepts GET.

The path is retranslator/protocols/list, plural. The singular form retranslator/protocol/list returns error 111.

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.

Body
objectOptional
Responses
200

The protocols

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/retranslator/protocols/list
POST /v2/retranslator/protocols/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
{
  "success": true,
  "list": [
    {
      "id": 1,
      "name": "text",
      "classname": "text",
      "has_login": true,
      "has_password": true,
      "required_login": true,
      "required_password": true,
      "fake_device_id_pattern": null
    }
  ]
}
PreviousMap layer
NextBLE beacon data

Last updated

Was this helpful?