Description: RestAPI v3 for managing your Freedomotic instance
Type: - Categories: API, Frontends, Networking & Communication
Development status: Beta version
Tested on: All platforms
Developer: Matteo Mazzoni
Note
This plugin is included in the package distribution
Useful configuration parameters you can insert into your plugin manifest:
Ports
Debugging options
SSL options
Cross Origin Resource Sharing options (change them very carefully!)
Extra options
You can learn the API and test it, simply accessing this URL: http(s)://{listen_address}:{port}/
e.g. if using default plugin configuration, go to https://localhost:9111/
WebSocket endpoints documentation
When subscribed to this channel, clients will get an updated thing (aka EnvObject) everytime any of them is modified. This is handy to keep a client updated without polling data.
When subscribed to this channel, clients will get a updated Zone when its boundaries are changed
When subscribed to this channel, clients will get a updated Plugin data when it is started/stopped or its configuration changes.
You can test API using the commandline tool cURL
Command format is
curl --user <username>:<password> http://<listen_address>:<port>/v3/<API>
For example if you want to retrieve the users’ list on our online demo authenticated as admin please digit
curl --user admin:admin http://api.freedomotic.com/9111/v3/users