Https Rest Api - Bosch LHN-UC15L-SIP User Manual

40 en | HTTPS REST API
5

HTTPS REST API

In a system with many devices, an operator may want to centrally supervise all devices and
start actions. A quick and easy way to do this is to share system states over an HTTPS API. An
HTTPS API communicates between the devices in a system via the Hypertext Transport
Protocol. This provides an easy way to collect and process requests.
There is a complete list of states and services available via the HTTP API documented on
https://<IP_Address>/api/index.html.
The HTTP API provides states for:
–
–
–
Notice!
i
To gain access to the API, you need to authenticate the according program with the user
credentials of an API user.
The IP Horn loudspeaker/IP Amplifier module provides status information to be read using the
GET command.
–
–
–
The IP Horn loudspeaker/IP Amplifier module provides the following information to be written
(e.g. via PUSH command):
–
Notes:
–
–
You can obtain more information on GPIs, GPOs, and further parameters in detail on
https://<IP_Address>/build/api/index.html.
2023.02 | V01 | F.01U.389.835
Getting and setting virtual GPIOs;
Getting systems states;
Getting and setting gains.
16 virtual GPOs - to display the status information for VGPO 4 use the command: GET
https://<IP_Address>/api/ext/v1/vgpos/4
16 virtual GPIs - to display the status information for VGPI 16 use the command: GET
https://<IP_Address>/api/ext/v1/vgpis/16
An overview of system states (BOOLEAN), such as message playing, power states,
memory usage, etc, use the command: GET https://<IP_Address>/api/ext/v1/status
16 virtual GPIs - use the command: PUT TRUE https://<IP_Address>/api/ext/v1/vgpis/16)
You must have a configured API user profile for access to the APIs. For more information,
see the Users page.
Set the physical GPO to follow any actions defined on the Rules page.
LHN‑UC15L‑SIP | LHN‑UC15W‑SIP | AMN‑P15‑SIP
User manual
Bosch Security Systems B.V.