Skip to content
API Reference/Messaging/
Process external messages

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

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

Process external messages

Request

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

Security
bearerAuth
Headers
customer_idstringrequired

Customer identifier

Example: Unique customer UUID
authorized_groupsstringrequired

Authorized groups for access control

Example: Unique customer sub-group UUID
message_typestringrequired

Type of message to process

Enum"DEVICE_DATA""MANIFEST_DATA""CARGOIQ"
Example: DEVICE_DATA
Bodyapplication/jsonrequired
message_typestring
Enum"DEVICE_DATA""MANIFEST_DATA""CARGOIQ"
Example: "DEVICE_DATA"
dataobject

Message data payload

curl -i -X POST \
  https://docs.trackonomy.com/_mock/external-api/trackonomy-external-api/external/messages \
  -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' \
  -H 'message_type: DEVICE_DATA' \
  -d '{
    "message_type": "MANIFEST_DATA",
    "data": {
      "asset_barcode": "EXAMPLE BARCODE",
      "shipped_date": 1755907016,
      "shipment_id": "EXAMPLE SHIPMENT ID",
      "container_id": "EXAMPLE CONTAINER ID"
    }
  }'

Responses

Successfully processed the message

Bodyapplication/json
messagestring
Example: "Successfully processed the message"
codenumber
Example: 201
Response
application/json
{
  "message": "Successfully processed the message",
  "code": 201
}
Copyright Trackonomy Systems Inc