Describes the /version, /reset and /descriptor endpoints.
Module RESTful API
The API allows you to use the function of each module.
The basic components like URL structure, versioning and error handling are generic over all modules.
Guide for rapid implementation
This guide is intended to enable a quick implementation and explain the most important points.
- Implement the version check and device selection.
This point is very important because we don’t want problematic implementations that go crazy after an update!
- Implement proper error handling.
- After the version check and device selection reset the device to initial state using /reset.
This is not needed if the application uses only “read” requests.
- Start by implementing all the GET requests and proceed with POST requests later.
- Some functions like /hard_reset, /watchdog or /limits can reset the entire system.
We do not recommend to implement them if they are not needed by the application!
- Implement the /notification endpoint if it is required by the documentation.
- Requests & Responses are JSON only.
- The JSON structure is case sensitive.
- The API does not support multiple “writable” applications at the same time.
The driver takes care of it, but the applications will eventually lose track of the state.
- Multiple parallel requests will increase the individual request time as they are not cached.
- Authentication is handled by a proxy server.
Describes how errors should be handled.
IO Module RESTful API documentation
Mainboard RESTful API documentation
Power Module RESTful API documentation
API versioning schema