APN settings

Mobile-internet settings a SIM needs before a device on it can reach the Navixy platform, looked up by phone number.

An access point name, or APN, is the mobile-internet configuration a SIM needs before the device holding it can reach the platform. This resource looks those settings up from a phone number.

The lookup is by number rather than by device, so the number does not have to belong to a registered tracker. Settings are resolved against the dealer that the current account belongs to.

API actions

API base path: /apn_settings.

---

Read APN settings

post

/apn_settings/read

Look up the mobile-internet APN settings for a phone number, so a device on that SIM can be configured to reach the platform.

The lookup is by number, not by tracker: the number does not have to belong to a registered device. Settings are resolved against the dealer the current account belongs to.

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

phonestringRequired

A valid international phone number without the leading +, digits only, for example 1234567890.

Responses

200

The APN settings

application/json

successbooleanRead-onlyOptional

true if request finished successfully.

Example: true

400

Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.

application/json

default

Error response object

application/json

post/apn_settings/read

POST /v2/apn_settings/read HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "phone": "text"
}

{
  "success": true,
  "value": {
    "name": "text",
    "user": "text",
    "password": "text",
    "operator_name": "text"
  }
}

Errors

These errors come in addition to the general error codes:

• 201 - The phone number is not found in the database.