API Basics

The Jetstream API enables you, a developer, to configure and query your Terso RFID devices and Jetstream application – allowing you to quickly enhance your business applications with RFID inventory tracking and management capabilities.

The page tree on the left helps you quickly jump between different sections and pages. You can quickly flip between Jetstream API Versions using the version selector in the page tree. Main provides the documentation for V3, and you can use the selector to view the documentation for Jetstream V2.

The table of contents on the right helps you quickly jump between different sections within the current page.

The search bar in the top right can be used to search on any content, on any page, for any version of the API.

The API Basics page contains everything you need to know about how to get requests to and responses from Jetstream, along with reference information like version changes and a glossary.

The OpenAPI Documentation for Jetstream page contains the OpenAPI documentation for Jetstream, including instructions on how to use this documentation and the latest JSON for the API.

The Device Types section tells you more about the various types of Terso RFID Devices that can be managed via Jetstream, including their commands, configuration parameters, logentryevents, and sensors.

The API Endpoints section contains detailed documentation of the various Jetstream API command and configuration endpoints, including descriptions, parameters, examples, and version changes.

The Event Types section contains descriptions, parameters, examples, and version changes for all events Jetstream may return in a Get Events call.

You can quickly flip between Jetstream API Versions using the version selector at the top of this user guide. Jetstream V3 is the current version, and you can use the selector to view the documentation for Jetstream V2.

Postman is a powerful tool that allows easy testing and experimenting of APIs. To start using Jetstream in Postman, first download and install Postman.

Here is a guide on how to create a Postman collection using the Swagger JSON: https://www.c-sharpcorner.com/article/import-swagger-apis-into-postman-collection/

See the OpenAPI Documentation for Jetstream page for a link to the JSON.

A .NET SDK and Service Base are available on Github.

Jetstream facilitates communication:

Let’s take a look at each communication path in more detail.

The base URL for this version of the Jetstream API is https://api.jetstreamrfid.com/2. Note the current version number in the URL, as well as the new domain name.

All requests to the Jetstream API must be made over HTTPS with TLS 1.2 or higher. HTTP requests and HTTPS requests using TLS 1.1 or earlier will not work.

All requests to the Jetstream API require authentication via a user access key. In the request header, set a 'AccessKey' key with your user access key as the value. A user access key is provided during user account sign up and is associated to a Jetstream application. A user access key is unique to a user and should be securely stored.

The Jetstream API accepts and sends data as JSON. For endpoints that send JSON data, define the header request’s ‘Content-Type’ key with a value of ‘application/json’.

The below HTTP verbs are used by the Jetstream API.

The Jetstream API returns data as JSON.

The below HTTP status codes are used by the Jetstream API.

Searching and sorting allow you to slim down and arrange the returned data, ensuring you only focus on the data you need.

Search and sort large result sets via passing parameters in the URL by including a query string. The details for each query type are outlined below.

Search can be used on its own, separate from sort, as follows:

In this example, we will be using the Get All Devices endpoint. Suppose you want to find all devices in your Jetstream application containing the name "terso". Here’s how to do so:

https://api.jetstreamrfid.com/2/devices?name=terso

Notes

What if you wanted to find all devices in your Jetstream application containing the names "terso" and "solutions"? It’s possible and here’s how to do so:

https://api.jetstreamrfid.com/2/devices?name=terso,solutions

Notes

Search on Multiple Properties

In this example, we will continue using the Get All Devices endpoint. Suppose you want to find all devices in your Jetstream application containing the name "terso", the serial number "1234", and the region "US". Here’s how to do so:

https://api.jetstreamrfid.com/2/devices?name=terso&serialnumber=1234&region=us

Notes

What if you wanted to find all devices in your Jetstream application containing the names "terso" and "solutions", the serial numbers "1234" and "4321", and the regions "US" and "AP"? It’s possible and here’s how to do so:

https://api.jetstreamrfid.com/2/devices?name=terso,solutions&serialnumber=1234,4321&region=us,ap

Notes

In this example, we will continue using the Get All Devices endpoint. Suppose you want to find all devices in your Jetstream application not containing the name "terso". Here’s how to do so:

https://api.jetstreamrfid.com/2/devices?name=!terso

Notes

What if you wanted to find all devices in your Jetstream application not containing the names "terso" and "solutions"? It’s possible and here’s how to do so:

https://api.jetstreamrfid.com/2/devices?name=!terso,solutions

Notes

In this example, we will continue using the Get All Devices endpoint. Suppose you want to find all devices in your Jetstream application that do not contain the name "terso", the serial number "1234", and the region "US". Here’s how to do so:

https://api.jetstreamrfid.com/2/devices?name=!terso&serialnumber=!1234&region=!us

Notes

What if you wanted to find all devices in your Jetstream application that do not contain the names "terso" and "solutions", the serial numbers "1234" and "4321", and the regions "US" and "AP"? It’s possible and here’s how to do so:

https://api.jetstreamrfid.com/2/devices?name=!terso,solutions&serialnumber=!1234,4321&region=!us,ap

Notes

Sort can be used on its own, separate from search, as follows:

In this example, we will be using the Get All Devices endpoint. Suppose you want to find all devices in your Jetstream application and sort by the "name" property. Here’s how to do so:

https://api.jetstreamrfid.com/2/devices?sort=name

Notes

Sort on Multiple Properties

In this example, we will continue using the Get All Devices endpoint. Suppose you want to find all devices in your Jetstream application and sort, first, by the "devicedefinition" property and, then, by the “region” property. Here’s how to do so:

https://api.jetstreamrfid.com/2/devices?sort=devicedefinition,region

Notes

Sort Descending on One Property

In this example, we will continue using the Get All Devices endpoint. Suppose you want to find all devices in your Jetstream application and sort by the “name” property, in descending order. Here’s how to do so:

https://api.jetstreamrfid.com/2/devices?sort=-name

Notes

Sort Descending on Multiple Properties

In this example, we will continue using the Get All Devices endpoint. Suppose you want to find all devices in your Jetstream application and sort, first, by the "devicedefinition" property and, then, by the "region" property, in descending order. Here’s how to do so:

https://api.jetstreamrfid.com/2/devices?sort=-devicedefinition,-region

Notes

Search and sort can be used together as follows:

In this example, we will be using the Get All Devices endpoint. Suppose you want to find all devices in your Jetstream application containing the name "terso" and sort by the "region" property. Here’s how to do so:

https://api.jetstreamrfid.com/2/devices?name=terso&sort=region

Notes

The key is to combine the search and sort parts of the query via the "&" character. Above is only one possible combination of search and sort to create a query. Reference the separate search and sort possibilities and combine them to create even more ways to search and sort.