# Trackonomy External API

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!

Version: 1.3.0.0

## Servers

PPE API for Locations data
```
https://ppe.api.trackonomy.com/external
```

PPE API for Historical data
```
https://ppe.mt.trackonomysystems.com
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT


## 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.

### Request the latest event with location and environmental data

 - [GET /locations/{asset_id}](https://docs.trackonomy.com/external-api/trackonomy-external-api/locations/get-location.md)

## 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.

### Request historical location and environmental data

 - [POST /agent-service/v1/agent/exec/e4735852-45a4-4d73-a4b4-b13b60fc5dfe](https://docs.trackonomy.com/external-api/trackonomy-external-api/historical-data/post-historical-data.md): Returns historical data.

## Device Management

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

### Decode single device BLE packet

 - [POST /external/v1/devices/{mac_id}/decode](https://docs.trackonomy.com/external-api/trackonomy-external-api/device-management/post-devices-decode.md): Decodes a BLE packet from a single device and returns sensor data including temperature, battery, shock events, and other telemetry information.

### Decode multiple device BLE packets

 - [POST /external/v1/devices/decode](https://docs.trackonomy.com/external-api/trackonomy-external-api/device-management/post-devices-decode-batch.md): Processes multiple BLE packets from different devices in a single request. Ideal for bulk operations and batch processing.

## 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.

### Process external messages

 - [POST /external/messages](https://docs.trackonomy.com/external-api/trackonomy-external-api/messaging/post-messages.md): Processes external messages including device patches and manifest data. Supports different message types for various data processing needs.