The Jetstream API adheres to REST architectural principles and utilizes JSON as its data-interchange format.
The Jetstream API enables you, a developer, to configure and query your Terso RFID devices and Jetstream application – allowing you to create impressive new applications or quickly enhance existing applications with RFID inventory tracking and management capabilities. In short,
You can explore Jetstream and its functionality by using Postman, a platform that allows easy testing of APIs. To import the Jetstream collection, click the "Run in Postman" button. Find more info here.
The base URL for this version of the Jetstream API is https://api.jetstreamrfid.com/3. 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.
Verb | Description |
---|---|
POST | Create a new resource. |
GET | Read/retrieve a resource. |
PUT | Update/replace a resource. |
DELETE | Delete a resource. |
PATCH | Delete a resource. |
The Jetstream API returns data as JSON.
The below HTTP status codes are used by the Jetstream API.
Status Code | Description |
---|---|
200 OK |
Successful GET, PUT, and POST requests pertaining to:
|
201 Created |
Successful POST requests pertaining to:
|
204 No Content |
Successful DELETE requests pertaining to:
Note: No message body is returned. |
400 Bad Request |
Pertains to:
Note: See the error message(s) given in the response message body for more details. |
401 Unauthorized |
Pertains to:
|
404 Not Found |
Pertains to:
|
500 Internal Server Error | Something went wrong on our end – we do our best to avoid these situations. Try your request again later. If this error persists, please contact us. |
Endpoint (Versions 2) | Replacement Endpoint (Version 3) |
---|---|
Get All Passes | Get Device Credentials |
Add and/or Remove Passes | Create Device Credentials Delete Device Credentials Sync Device Credentials |
Replace All Passes | Modify Device Credentials |
Event (Versions 2) | Replacement Event (Version 3) |
---|---|
LogicalDeviceAddedEvent | DeviceAddedEvent |
LogicalDeviceRemovedEvent | DeviceRemovedEvent |
Searching and/or sorting allows you to slim down the returned data, ensuring you only focus on the data you need.
Search and/or 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 "beer". Here’s how to do so:
https://api.jetstreamrfid.com/3/devices?name=beer
Notes
What if you wanted to find all devices in your Jetstream application containing the names "beer" and "cheese"? It’s possible and here’s how to do so:
https://api.jetstreamrfid.com/3/devices?name=beer,cheese
Notes
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 "beer", the serial number "1234", and the region "US". Here’s how to do so:
https://api.jetstreamrfid.com/3/devices?name=beer&serialnumber=1234®ion=us
Notes
What if you wanted to find all devices in your Jetstream application containing the names "beer" and "cheese", 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/3/devices?name=beer,cheese&serialnumber=1234,4321®ion=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 "beer". Here’s how to do so:
https://api.jetstreamrfid.com/3/devices?name=!beer
Notes
What if you wanted to find all devices in your Jetstream application not containing the names "beer" and "cheese"? It’s possible and here’s how to do so:
https://api.jetstreamrfid.com/3/devices?name=!beer,cheese
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 "beer", the serial number "1234", and the region "US". Here’s how to do so:
https://api.jetstreamrfid.com/3/devices?name=!beer&serialnumber=!1234®ion=!us
Notes
What if you wanted to find all devices in your Jetstream application that do not contain the names "beer" and "cheese", 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/3/devices?name=!beer,cheese&serialnumber=!1234,4321®ion=!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/3/devices?sort=name
Notes
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/3/devices?sort=devicedefinition,region
Notes
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/3/devices?sort=-name
Notes
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/3/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 "beer" and sort by the "region" property. Here’s how to do so:
https://api.jetstreamrfid.com/3/devices?name=beer&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.