Introduction

Each device that is to access the Recognition API must be setup in the Tiliter database.

When a device is initially registered, it must be given a unique ID, Camera type, Operational mode, Store ID and Department code:

Device property	API field	Data type	Description
Device ID	device_id	string	A unique identifier for the device
Camera type	cameras	array of strings	The type of camera on the device. Valid values are defined in the API specs.
Operational mode	operational_mode	enum	Who uses the device. Valid values are defined in the API specs. Can only be staff_only or customer
Store ID	store_id	string	The store ID the device is located in. Responses will be filtered based on the in stock items in the store the device is in.
Department	departments	array of strings	The responses will be filtered based on the department the device is in. Valid values are defined in the API specs.

Creating Devices

Here's how to create a device using a Unix-like command-line interface:

curl --request POST --url https://recognition.services.tiliter.com/devices/device_id --header 'accept: application/json' --header 'content-type: application/json' --header 'tiliter-api-key: YOUR_API_KEY' --data ' { "cameras": [ "generic" ], "operational_mode": "customer", "departments": [ "fresh_produce" ], "device_id": "device_id", "store_id": "store_id" } '

More information on the product parameters can be found in Create Device

Like Stores, Devices can be created, updated, and deleted, and can also be retrieved in a list, and retrieved individually using the API functions provided.

Ongoing Device Management

New stores open all the time, and when each one opens, new devices will need to be created and setup just like existing devices were.

The process is exactly the same from a technical perspective. It is recommended to establish practices and processes that ensure that devices creation within the Tiliter Recognition API is part of the standard checklist of work required to open a new store.

Conclusion

Every recognition request needs to specify a device ID. Creating and managing devices is required to use the Recognition API. Good management of devices will result in the best outcomes, performance, and accurate and useful usage and performance statistics. For more information, see Devices.