Depending on the level of integration or use cases Maxx Remote is intended to be use, there are several entry points to get data or views out of the server.
This is the multi-page printable view of this section. Click here to print.
API
Different API entry points are available to the maxx-remote-server
- 1: GROUP-SIGNAL-PATH
- 2: REST-API
- 3: VIEW API
1 - GROUP-SIGNAL-PATH
The SIG-PATH view form the GUI as standalone web page but scoped per group-id
GROUPS are addressed via an internal UUID (unique id), like 36875a19-8203-4647-9760-303ffd3c8f8f
To get a scoped view of that group in the SIG-PATH, the group-id could be called with the http://{server}:8000/group-signal-path/{uuid} url, e.g. http://localhost:8000/group-signal-path/36875a19-8203-4647-9760-303ffd3c8f8f
2 - REST-API
API calls to the maxx-remote server
Similar approach as the HTTP api like used by MAXX-CONTROL but this time, controlling the server itself.
This is intended as main entry point to the maxx-remote system from an third party control perspective like media controls, etc.
Functionality is more focused on end user control than really setup the system.
The full open-api documentation of that api is shipped within each Maxx-Remote system, and can be found on the lower left HOME section.
Or through that url http://localhost:8000/api-docs/ when a maxx-remote is running on your system.