Skip to content
/Device Management

Trackonomy External API (1.3.0.0)

External APIs are meant for interacting with Trackonomy Platform. New endpoints will be added regularly. Current APIs enable the following:

  • retrieve location and environmental data for assets tracked with Trackonomy tapes.
  • decode Trackonomy BLE packets
  • send various messages from third party systems for integration purposes

Locations endpoint can be used for the latest event, Historical data endpoint reveals also older data with about 15 minute delay. Note that today authentication is separated for the 2 location data endpoints!

Download OpenAPI description
trackonomy-external-api.json
trackonomy-external-api.yaml
Overview
URL
https://trackonomy.ai/contact-us/
Developer Support
developers@trackonomysystems.com
Languages
Servers
Mock server
https://docs.trackonomy.com/_mock/external-api/trackonomy-external-api/
PPE API for Locations data
https://ppe.api.trackonomy.com/external/
PPE API for Historical data
https://ppe.mt.trackonomysystems.com/

Locations

This API allows to request location and environmental data for assets tracked with Trackonomy tapes.

available sensor data depends on the exact model of tape used and sensor configuration applied to the specific device. Value -255 indicates sensor unavailability.

location_detailed info can only be returned if Trackonomy indoor network is used by customer at the given location.

Operations

Historical data

This endpoint allows requesting historical location and environmental data based on provided filters. Up to 1 year of history is available, at once maximum 1 month or 1000 events can be fetched. If no time frame provided, the latest event is returned.

Operations

Device Management

Service to decode BLE packets either one by one or in batch

Operations

Decode single device BLE packet

Request

Decodes a BLE packet from a single device and returns sensor data including temperature, battery, shock events, and other telemetry information.

Security
bearerAuth
Path
mac_idstringrequired

Device MAC address

Example: Trackonomy device macid
Headers
customer_idstringrequired

Customer identifier

Example: Unique customer UUID
authorized_groupsstringrequired

Authorized groups for access control

Example: Unique customer sub-group UUID
product_idstringrequired

Product identifier

Example: Unique Trackonomy device identifier
ble_packetstringrequired

BLE packet data to decode

Example: Encoded Trackonomy device data
scan_timestringrequired

Scan timestamp

Example: Event time
curl -i -X POST \
  'https://docs.trackonomy.com/_mock/external-api/trackonomy-external-api/external/v1/devices/Trackonomy device macid/decode' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'authorized_groups: Unique customer sub-group UUID' \
  -H 'ble_packet: Encoded Trackonomy device data' \
  -H 'customer_id: Unique customer UUID' \
  -H 'product_id: Unique Trackonomy device identifier' \
  -H 'scan_time: Event time'

Responses

Successfully decoded BLE packet

Bodyapplication/json
qr_codestring
Example: "TRK123456789"
ctsnumber
Example: 1730813898
tsnumber
Example: 1730813898
batnumber
Example: 3.2
tempnumber
Example: 22.5
over_tempnumber
Example: 35
over_temp_tsnumber
Example: 1730813800
shocknumber
Example: 2.5
shock_tsnumber
Example: 1730813800
shock_countnumber
Example: 3
fw_verstring
Example: "1.2.3"
Response
application/json
{
  "qr_code": "TRK123456789",
  "cts": 1730813898,
  "ts": 1730813898,
  "bat": 3.2,
  "temp": 22.5,
  "over_temp": 35,
  "over_temp_ts": 1730813800,
  "shock": 2.5,
  "shock_ts": 1730813800,
  "shock_count": 3,
  "fw_ver": "1.2.3"
}

Decode multiple device BLE packets

Request

Processes multiple BLE packets from different devices in a single request. Ideal for bulk operations and batch processing.

Security
bearerAuth
Headers
customer_idstringrequired

Customer identifier

Example: Unique customer UUID
authorized_groupsstringrequired

Authorized groups for access control

Example: Unique customer sub-group UUID
Bodyapplication/jsonrequiredArray [
mac_idstringrequired
Example: "Trackonomy device macid"
ble_packetstringrequired
Example: "Encoded Trackonomy device data"
product_idstringrequired
Example: "Unique Trackonomy device identifier"
scan_timestringrequired
Example: "Event time"
]
curl -i -X POST \
  https://docs.trackonomy.com/_mock/external-api/trackonomy-external-api/external/v1/devices/decode \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'authorized_groups: Unique customer sub-group UUID' \
  -H 'customer_id: Unique customer UUID' \
  -d '[
    {
      "mac_id": "A1B2C3D4E5F6",
      "ble_packet": "XXXXXXXX",
      "product_id": "example-device",
      "scan_time": "1730813898"
    },
    {
      "mac_id": "A1B2C3D4E5F6",
      "ble_packet": "YYYYYYYYYYYY",
      "product_id": "example-device",
      "scan_time": "1730813899"
    }
  ]'

Responses

Successfully processed bulk decode request

Bodyapplication/jsonArray [
mac_idstring
Example: "A1B2C3D4E5F6"
qr_codestring
Example: "TRK123456789"
ctsnumber
Example: 1730813898
tsnumber
Example: 1730813898
batnumber
Example: 3.2
tempnumber
Example: 22.5
errorstring
Example: "Invalid BLE packet"
]
Response
application/json
[
  {
    "mac_id": "A1B2C3D4E5F6",
    "qr_code": "TRK123456789",
    "cts": 1730813898,
    "ts": 1730813898,
    "bat": 3.2,
    "temp": 22.5,
    "error": "Invalid BLE packet"
  }
]

Messaging

Service to process external messages and modify device status based on the inputs. NB! Usage of the given API needs prior alignment with customer as each received message and intended behavior is different. Provided examples are some possible ways to use the endpoint.

Operations
Copyright Trackonomy Systems Inc