External Interface; Iot Device; Rest-Api - Bosch rexroth ActiveShuttle System Manual

8 External Interface

8.1 IoT Device

ActiveShuttle Management System (AMS) allows the possibility of triggering specific Jobs using IoT Devices.
The IoT Devices can be created and configured in the "Path Editor" section under User interface → Sidebar.
Prerequisite
We assume that the network configurations of the IoT Devices are already completed. The IoT Devices
needs to have a network communication between the AMS and the device itself.
The device will trigger a specific Job in the AMS using the Device_Id configured in the Path Editor → IoT
Devices. The IoT Device needs to be configured to trigger the AMS Job using the REST protocol.
URL helper string
The AMS Job trigger URL can be constructed using the sample URL shown below
https://[ams-url]:[commodore-service-port]/api/v1/[device_trigger_id]/trigger?apikey=[ams-apikey]
ams-url: localhost or server IP address here
commodore-service-port: 8547 or mapped Docker port
device_trigger_id: trigger ID of the respective device from AMS
ams-apikey: AMS api key from the AMS → Settings → General
Test
To test whether the URL is correct,
1. please open a browser
2. enter the created URL into the address bar
3. now press "Enter" → this should create the respective Job in the AMS.
4. the message "Success" will be displayed in the browser as well once you click "Enter"

8.2 REST-API

AMS provides access to several objects in the system via the web service REST-API.
REST-API allows
• The communication with external systems in order to acquire and send information to the AMS.
• External systems to control the routes and the Jobs the ActiveShuttles perform.
Notice
For setting the API-Key use numbers and special characters.
API-Key provides access to the interface in 2 ways:
• As an environment variable "API_KEY" in the hmisrv service.
• Using the UI, in General Settings:
RA91390962 AB-V1.3.3, en
External Interface | ILS, ActiveShuttle | 139