Overview

In hospitality environments, a closed-loop system ensures that only authorized devices can access the system. This is achieved through device segments, which group devices that can then be assigned to a market.

To fully understand how device segments and markets function, we recommend reading about those concepts first. Once a market is designated as the invited market, only devices within that market are permitted to access the system. Unauthorized devices will display an informational screen containing text and a QR code with device details.

Before a device can be added to a market, it must first be registered in the system.

Device Registration Methods

Devices can be registered in one of two ways:

• On App Boot (Recommended): When the application first starts on a device, it automatically registers itself with the system. This is the preferred method to ensure accuracy and avoid manual errors.
• Manual API Registration: Devices can be registered manually via the API without the app ever being launched. However, this approach increases the risk of errors and should be used only when necessary.

Once registered, a device can then be added to a device segment.

Retrieving Device IDs for Invited Markets

There are three primary ways to obtain the device IDs needed to add devices to an invited market:

• Externally: The device identifier can be retrieved from the box, the system, or an MDM (Mobile Device Management) system.
• Dashboard: When the app first boots, it registers itself with the system. This information can then be viewed from the dashboard or retrieved on the API.
• QR Code: If a device is not part of the invited market, it will display a QR code with its Device ID and other metadata. A QR scanning app can be used to retrieve these details.

Adding Devices to a Device Segment

Once Device IDs are retrieved, they can be assigned to a Device Segment, which can then be placed into a market and used as the invited market. Devices can be added to a device segment in two ways:

• UI: The dashboard allows for Device IDs to be easily added to segments.
• API: Device IDs can be programmatically assigned to a segment using API calls.

Summary

• Device segments group devices for market assignment.
• Markets control which devices are authorized to access the system.
• Devices must be registered before they can be assigned to a segment.
• Device IDs can be retrieved externally, via the dashboard, or QR codes.
• Devices are added to a segment via UI or API, enabling access through an invited market.

By following this structured approach, you ensure that only authorized devices can access the system, improving security and operational efficiency.