The Kiosker API offers a RESTful interface for seamless interaction with the Kiosker app, employing JSON for both request and response bodies to ensure efficient and standardized data exchange.
\nWe strongly recommend that the API is accessed via HTTPS. Enable TLS by generating a self-signed TLS certificate and importing it into Kiosker. Please refer to the documentation for more information.
\nAuthentication is conducted via a static bearer token. The token is device-specific and generated in the Kiosker App. Pass the token in the Authorization header, eg. \"Authorization: Bearer ABC123\". Replace ABC123 with your token.
\nAdded get screensaver state by [GET] screensaver/state.
\nBREAKING: Renamed blackOut object to blackout. This is a typo fix.
\nTerms of service
Contact the developer
Kiosker app documentation
| Error | ","Function | ","Status | ","
|---|---|---|
| {{response.error}} | ","{{response.function}} | ","{{response.status}} | ","
This endpoint allows you to retrieve the current status, including battery level, last motion, device ID, last interaction, model, date, battery state, and OS version.
\nUpon a successful request, the server will respond with a JSON object containing the status information. The response will include the following fields:
\nerror (boolean): Indicates if an error occurred.
function (string): Always \"status\" for this request
status (object): Contains the status details, including:
batteryLevel (integer): The current battery level as integer in range 0-100.
lastMotion (string): Timestamp of the last motion detected. A screensaver with motion detection enabled must be active.
deviceId (string): The unique identifier of the device.
lastInteraction (string): Timestamp of the last user interaction.
model (string): The model of the device.
date (string): Date of the status report.
batteryState (string): The state of the battery.
osVersion (string): The operating system version of the device.
| Error | ","Function | ","Status | ","
|---|---|---|
| {{response.error}} | ","{{response.function}} | ","{{response.status}} | ","
| Error | ","Function | ","Status | ","
|---|---|---|
| {{response.error}} | ","{{response.function}} | ","{{response.status}} | ","
| Error | ","Function | ","Status | ","
|---|---|---|
| {{response.error}} | ","{{response.function}} | ","{{response.status}} | ","
| Error | ","Function | ","Status | ","
|---|---|---|
| {{response.error}} | ","{{response.function}} | ","{{response.status}} | ","
| Error | ","Function | ","Status | ","
|---|---|---|
| {{response.error}} | ","{{response.function}} | ","{{response.status}} | ","
| Error | ","Function | ","Status | ","
|---|---|---|
| {{response.error}} | ","{{response.function}} | ","{{response.status}} | ","
| Error | ","Function | ","Status | ","
|---|---|---|
| {{response.error}} | ","{{response.function}} | ","{{response.status}} | ","
| Error | ","Function | ","Status | ","
|---|---|---|
| {{response.error}} | ","{{response.function}} | ","{{response.status}} | ","
| Error | ","Function | ","Status | ","
|---|---|---|
| {{response.error}} | ","{{response.function}} | ","{{response.status}} | ","
| Error | ","Function | ","Status | ","
|---|---|---|
| {{response.error}} | ","{{response.function}} | ","{{response.status}} | ","
| Error | ","Function | ","Status | ","
|---|---|---|
| {{response.error}} | ","{{response.function}} | ","{{response.status}} | ","
| Error | ","Function | ","Status | ","
|---|---|---|
| {{response.error}} | ","{{response.function}} | ","{{response.status}} | ","
| Error | ","Function | ","Status | ","
|---|---|---|
| {{response.error}} | ","{{response.function}} | ","{{response.status}} | ","
| Error | ","Function | ","Status | ","
|---|---|---|
| {{response.error}} | ","{{response.function}} | ","{{response.status}} | ","