API docs by Redocly

Trackonomy Core Services API (1.0.0)

Download OpenAPI specification:

Welcome to the Trackonomy Core Services API documentation. This comprehensive API provides real-time asset tracking, device management, and messaging capabilities for enterprise customers.

Key Features

  • Real-time Asset Tracking: Get live location data for assets with detailed event information
  • Device Management: Decode BLE packets from IoT devices and manage device associations
  • Bulk Operations: Process multiple devices and packets efficiently
  • Messaging System: Handle device patches and manifest data processing

NOTE: All the cURL APIs provided below are examples.

Authentication

All API endpoints require JWT Bearer token authentication. Include your token in the Authorization header:

Authorization: Bearer <your-jwt-token>

Getting an Access Token

To obtain an access token, make a POST request to the Auth0 OAuth endpoint:

curl --request POST \
  --url https://application-core-services-dev.us.auth0.com/oauth/token \
  --header 'Content-Type: application/json' \
  --data '{
    "client_id": "customer_client_id",
    "audience": "application_audience",
    "grant_type": "password",
    "username": "customer@trackonomysystems.com",
    "password": "customer_password"
}'

Response:

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 86400
}

Use the access_token from the response in the Authorization header for all API requests.

Required Headers

Most endpoints require the following headers:

  • customer_id: Your customer identifier
  • authorized_groups: Your authorized group for access control
  • correlation_id: Optional request correlation ID for tracking

Base URL

The API is available at: https://api.trackonomy.com

Location

Get Asset Location Data

Retrieves the latest location event data for a specific asset (AWB). Returns detailed information about the asset's current location, event type, and timestamp.

Authorizations:
bearerAuth
path Parameters
asset_id
required
string
Example: Asset Barcode

Asset identifier to fetch location data for

query Parameters
event
string
Example: event=sensor

Optional event type filter. Use "sensor" to get sensor-specific data

header Parameters
customer_id
required
string
Example: Unique customer UUID

Customer identifier for the request

authorized_groups
required
string
Example: Unique customer sub-group UUID

Authorized groups for access control

correlation_id
string
Example: UUID

Optional correlation ID for request tracking

Responses

Response samples

Content type
application/json
{
  • "version": "1.0.0",
  • "uuid": "a51799fa-4765-4f9c-9460-2d44fc2fe27f",
  • "vendor_id": "c59f7130-e0b7-4aff-ac6e-a97dcfbd9222",
  • "assets": [
    ]
}

Device Management

Decode Single Device BLE Packet

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

Authorizations:
bearerAuth
path Parameters
mac_id
required
string
Example: Trackonomy device macid

Device MAC address

header Parameters
customer_id
required
string
Example: Unique customer UUID

Customer identifier

authorized_groups
required
string
Example: Unique customer sub-group UUID

Authorized groups for access control

product_id
required
string
Example: Unique Trackonomy device identifier

Product identifier

ble_packet
required
string
Example: Encoded Trackonomy device data

BLE packet data to decode

scan_time
required
string
Example: Event time

Scan timestamp

Responses

Response samples

Content type
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

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

Authorizations:
bearerAuth
header Parameters
customer_id
required
string
Example: Unique customer UUID

Customer identifier

authorized_groups
required
string
Example: Unique customer sub-group UUID

Authorized groups for access control

Request Body schema: application/json
required
Array
mac_id
required
string
ble_packet
required
string
product_id
required
string
scan_time
required
string

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Messaging

Process External Messages

Processes external messages including device patches and manifest data. Supports different message types for various data processing needs.

Authorizations:
bearerAuth
header Parameters
customer_id
required
string
Example: Unique customer UUID

Customer identifier

authorized_groups
required
string
Example: Unique customer sub-group UUID

Authorized groups for access control

message_type
required
string
Enum: "DEVICE_DATA" "MANIFEST_DATA" "CARGOIQ"
Example: DEVICE_DATA

Type of message to process

Request Body schema: application/json
required
message_type
string
Enum: "DEVICE_DATA" "MANIFEST_DATA" "CARGOIQ"
data
object

Message data payload

Responses

Request samples

Content type
application/json
Example
{
  • "message_type": "MANIFEST_DATA",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "message": "Successfully processed the message",
  • "code": 201
}