Overview
The XD150FX uses a RESTful JSON (JavaScript Object Notation) based API which is also incorporated in its own web interface for configuration and control. A copy of the API in YAML form can be download from the link below. This version was taken from
Download YAML file
Best Practices
- Do not keep the HTTP port open. When making a request, simply send the API command, wait for the response and then close the connection. There is no guarantee that the HTTP connection that you initially establish will always remain open.
- The API is restful based, this means that you have to periodically request information from the XD150FX and compare the previous and latest responses to see what has changed. Be careful not to continuously send API requests as they consume resources on the XD150FX.
API
By default, you must first authenticate with the XD150FX. This can be disabled in the System Settings if you require. Once connected, you can simply interact with the XD150FX using JSON.
The Base URL is http://<IPADDRESS>/api where <IPADDRESS> is the IP address of the XD150FX .
For example, in order to retrieve a JSON response showing the Transmitters Monitor EDID you would send http://<IPADDRESS>/api/transmitter/edid. etc.
Working with JSON is beyond the scope of this wiki, however, there are plenty of resources online that will help you to interact with this product.
Note
When sending POST commands, if there are no variables for the command, always send an empty payload, e.g. {}, otherwise you will not get a response.