Asset Tracking REST API

Asset Tracking REST API

Some fields in this API, marked in red below, are deprecated and will eventually be removed. If you are using these fields, please update your application to retrieve this data from the new Asset Tracking REST APIs, which are documented here:

https://tags.meridianapps.com/docs/v1#tag/RESTAPI

Some additional tags API documentation can be found at https://edit.meridianapps.com/docs#tag/api

Rest vs Streaming

Meridian provides both Rest APIs and Streaming APIs. The Streaming APIs are designed for real-time data needs and the Rest APIs are designed from static data needs. For example, if you need to know the current location of your Tags, this would be a good use of the Streaming APIs. And if you need a list of all Tags to sync with an internal inventory record on a daily or hourly basis, this would be a good use of the Rest APIs.

WARNING: It is highly recommended that you do not use the Rest API for real-time data needs as this volume of traffic can cause the service performance to degrade. Calling the Rest APIs every second to determine the location of Tags may result in your usage being throttled or blocked to protect the overall performance of the system.

The Asset-beacons Endpoint

The asset-beacons endpoint can be used to get information about tags that have been deployed to a location or to upload an image to a Tag.

/api/locations/{location_id}/asset-beacons

This endpoint will return BLE Tag information without current position.

Response

[TABLE]

GET a single Tag

You can use the asset-beacons endpoint to get the location of a specific Tag.

BLE Tags aren’t tracked in real-time. The API isn’t intended for this purpose.

/api/locations/{location ID}/asset-beacons/{MAC address}

Response

The response to a single Tag is the same as the response for all tags with these properties structured as a dictionary (each level represented with a greater than):

[TABLE]

Upload Images

You can use the asset-beacons endpoint to upload, replace, or delete an image for a specific BLE Tag.

/api/locations/{location ID}/asset-beacons/{MAC}/image

Use PUT to upload or replace an image. Use DELETE to remove an image. Use GET to grab a Tag’s image.

Labels

BLE Tag labels are collected in the tag_ids field.

The tag_ids field is an array of unique label identifiers. The tags field contains ids and label names.

Learn more about using Labels in the Asset Tag Label API article.

Check Tags Accuracy

Create a Tag

Use POST to create a new Tag.

The required values are name and mac. The external_id value is optional.

External ID is used to relate a Tag to a non-Meridian resource, such as an inventory database.

    /api/locations/{location ID}/asset-beacons

Delete a Tag

Use DELETE to remove a Tag from your location.

    /api/locations/{location ID}/asset_beacons/{MAC}