petWALK.control local API (beta) (1.0.0)
Download OpenAPI specification:Download
This API is for local access of main petwalk door states and modes, i.e. for smart home integration purpose.
Note: for using this API, optional petWALK.control module is required. For more information visit www.petwalk.at
The API functionality is disabled by default on the petwalk.control module (firmware version 1.1 or later required) and must be enabled by the user in the petWALK smartphone app or webapp: https://control.petwalk.solutions
Important Note
This API is in BETA state without any warranty and to be used "as is". Petwalk does NOT provide any technical support regarding use of this API beyond this documentation.
However, we highly appreciate constructive feedback for further improvement of this API: support@petwalk.at
See petWALK-App -> { your door } -> Advanced Settings -> REST API for determing local network ip address (firmware version 1.1 or later required)
Change active modes
Change current modes of your petWALK door.
Note: you can only include a single mode in request body, if you don't want to change all of them!
Detailed settings i.e. for brightness sensor sensitivity cannot be set via API and must be changed via petWALK smartphone app or webapp: control.petwalk.solutions
Request Body schema: application/json
| brightnessSensor | boolean |
| motion_in | boolean |
| motion_out | boolean |
| rfid | boolean |
| time | boolean |
Responses
Request samples
- Payload
{- "brightnessSensor": true,
- "motion_in": true,
- "motion_out": true,
- "rfid": true,
- "time": true
}Change door state
Change petWALK door states
Request Body schema: application/json
| door | string non-empty Default: "closed" Enum: "open" "closed" door leaf state: open or closed |
| system | string non-empty Default: "off" Enum: "on" "off" system state: on or off |
Responses
Request samples
- Payload
{- "door": "open",
- "system": "on"
}