How to: Use Alta Aware APIs to add POS devices to a deployment

Last modified: Friday September 15, 2023

The open Alta Aware Application Programming Interface (API) allows for powerful automation to be built around the core Aware platform. One possible implementation of this is to bulk add point-of-sale (POS) devices to a deployment rather than requiring a user to manually add each one.

For more information about the API, see Introducing: Alta Aware API and How to: Get started with the Alta Aware API

The following POS-specific endpoints are available for configuration and communication:

• /api/v1/pointOfSaleSystems
• /api/v1/pointOfSaleSystems/<pos_id>
• /api/v1/pointOfSaleSystems/<pos_id>/webhooks
• /api/v1/pointOfSaleSystems/<pos_id>/webhooks/{<webhook_id>
• /api/v1/registers
• /api/v1/registers/<register_id>

Normal REST API operations, such as GET, POST, PUT, and DELETE, are available to POS systems. For more details use the API explorer.

An outline of an automation is:

• GET /api/v1/pointOfSaleSystems - enumerate the current point of sale systems
• GET /api/v1/deviceGroups - enumerate the device groups
• For each register to be added call POST /api/v1/registers supplying a json structure with “name”, “external_id”, “point_of_sale_id” and “device_group_id” fields.