# Tracking Device API

The Tracking Device API is a unified interface to post or request information about tracking devices. Usually a tracking device is a vehicle, which needs to be registered to our platform before you can feed GPS data to other endpoints.

*Make sure you request the Auth API first*

Version: 2.0

## Servers

Production Environment
```
https://tracking-device-api.services.simacan.com/api/public/v2
```

Staging Environment
```
https://tracking-device-api-stg.services.simacan.com/api/public/v2
```

## Security

### BearerAuth

Before any request you do, make sure you have obtained an access token from the Auth API. You need to send the access token through an HTTP Authorization request header

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Tracking Device API](https://simacan-developer-portal-2-0.redocly.app/_bundle/openapi/device/trackingdevice.yaml)

## Other

### Register or update a tracking device

 - [POST /](https://simacan-developer-portal-2-0.redocly.app/openapi/device/trackingdevice/other/posttrackingdevice.md): Registers a new or updates an existing tracking device depending if the device is already known. A device is defined by a unique combination of the externalSystemId and the externalDeviceId. So registering an already existing device will update all the attributes except the DeviceUUID

### Register or update a tracking device

 - [PUT /](https://simacan-developer-portal-2-0.redocly.app/openapi/device/trackingdevice/other/puttrackingdevice.md): Registers a new or updates an existing tracking device depending if the device is already known. A device is defined by a unique combination of the externalSystemId and the externalDeviceId. So registering an already existing device will update all the attributes except the DeviceUUID

### Retrieve all devices

 - [GET /](https://simacan-developer-portal-2-0.redocly.app/openapi/device/trackingdevice/other/gettrackingdevices.md): Retrieves all devices of the associated carriers of the authenticated account.

### Retrieve a device by externalDeviceId

 - [GET /external-system/{externalSystemId}/external-device/{externalDeviceId}](https://simacan-developer-portal-2-0.redocly.app/openapi/device/trackingdevice/other/gettrackingdevicebyid.md): Retrieves a single device of the associated carrier of the authenticated account, based on the externalDeviceId

### Retrieve device by license plate

 - [GET /external-system/{externalSystemId}/license-plate/{licensePlate}](https://simacan-developer-portal-2-0.redocly.app/openapi/device/trackingdevice/other/gettrackingdevicebylicenseplate.md): Retrieves a single device of the associated carrier of the authenticated account, based on the linked license plate