API

Use the Jetstream REST API to queue commands for your device or configure your application. Use GetEvents to begin receiving your Jetstream events.

For developers just getting started, we recommend going through the Jetstream Developers Guide and logging in to the Admin Console to add a device and simulate events. When you are ready to develop, use the Jetstream tools and open source projects to aid you in your journey.

command

Jetstream let's you queue commands for your RFID devices. Devices can be placed on any internet based network; therefore, Jetstream will handle all the complexity of coordinating the delivery, execution and returning the results of your command request.

To Execute a Command
  1. Your application calls the Jetstream REST API with a command request.
  2. The Jetstream REST API returns to you a unique CommandId.
  3. The Jetstream REST API queues the command with the closest device web server.
  4. The device polls the edge device web server for any new commands and pops your command.
  5. The device executes your command.
  6. The device sends a CommandCompletionEvent for your command to the edge device web server
  7. The edge device web server sends the event to Jetstream
  8. GetEvents recieves the event from your Jetstream topic
  9. Your application processes the event based on your business rules

More Info

CommandId is the unique identifier to correlate your command request with the resulting CommandCompletionEvent

configuration

At any time you may reconfigure your Jetstream application to add or remove devices, get your current application configuration, determine what types of devices are available to add or keep your devices configured to meet a policy.

To Configure Your Application
  1. Your application calls the Jetstream REST API with a configuration request
  2. The Jetstream REST API configures your application
  3. The Jetstream REST API returns a ConfigureResponse to your application
configuration

Jetstream automatically publishes device and system events to your application.

To Receive an Event
  1. The device or the Jetstream REST API generates an event
  2. The Jetstream REST API publishes the event
  3. GetEvents recieves the event from your Jetstream topic
  4. Your application processes the event based on your business rules

Jetstream supports multiple RFID device types and abstracts the type of device from your application. Therefore you can configure, command and receive events from any device using the same code. Device metadata is managed through DeviceDefintion which allows devices to define the commands and config values it supports in Jetstream. Device types that support more than just the standard commands can define their own commands using the DeviceSpecificCommand. Finally devices that require custom event data can publish their event data with the standard events using the DeviceExtension elements found in the standard event schemas.