Kiosker API

https://swagger.kiosker.io
Admin
The Kiosker API offers a RESTful interface for seamless interaction with the Kiosker app, employing...
Tokens:9,063
Snippets:57
Trust Score:6.3
Update:10 months ago
Show doc for...
Tokens:
Raw
### POST /navigate/home

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Navigates the website to its starting page. This endpoint is part of the Navigation API group.

```APIDOC
## POST /navigate/home

### Description
Navigates the website to its starting page.

### Method
POST

### Endpoint
/navigate/home

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred.
- **function** (string) - The name of the function executed.

#### Response Example
```json
{
  "error": false,
  "function": "navigate/home"
}
```

#### Error Responses
- **401**: Authentication failed.
  - **reason** (string) - Reason for authentication failure.
- **403**: IP Filtering failed.
  - **reason** (string) - Reason for IP filtering failure.
```

--------------------------------

### GET /devices/data

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Retrieves the current status and configuration data for a specific device. This includes ambient light, date, device ID, application name, and version.

```APIDOC
## GET /devices/data

### Description
Retrieves the current status and configuration data for a specific device. This includes ambient light, date, device ID, application name, and version.

### Method
GET

### Endpoint
/devices/data

### Parameters
#### Query Parameters
- **deviceId** (string) - Required - The unique identifier of the device.

### Response
#### Success Response (200)
- **ambientLight** (number) - The current unitless ambient light. Will be null if camera sensor is disabled.
- **date** (string) - The current date in ISO8601 format.
- **deviceId** (string) - A unique identifier for the device.
- **appName** (string) - The name of the app, such as Kiosker or Kiosker Pro.
- **appVersion** (string) - The version of the app.

#### Response Example
```json
{
  "ambientLight": 1.2,
  "date": "2023-10-27T10:00:00Z",
  "deviceId": "00000000-0000-0000-0000-000000000000",
  "appName": "Kiosker Pro",
  "appVersion": "25.4.1 (236)"
}
```
```

--------------------------------

### GET /status

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Retrieves the current status of the kiosk. This includes information like app version, app name, ambient light, and whether the kiosk is in kiosk mode.

```APIDOC
## GET /status

### Description
Get the current kiosk status.

### Method
GET

### Endpoint
/status

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred (false for success).
- **function** (string) - The name of the function called (e.g., "status").
- **appVersion** (string) - The version of the Kiosker app.
- **appName** (string) - The name of the Kiosker app.
- **ambientLight** (integer) - The current ambient light level detected by the kiosk.
- **kioskMode** (boolean) - Indicates if the kiosk is currently in kiosk mode.

#### Response Example
```json
{
  "error": false,
  "function": "status",
  "appVersion": "25.9.1 (236)",
  "appName": "Kiosker Pro",
  "ambientLight": 500,
  "kioskMode": true
}
```

#### Error Responses
- **401 Unauthorized**: Authentication failed.
- **403 IP Filtering failed**: IP address is not allowed to access the API.
```

--------------------------------

### GET /ping

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Pings the kiosk to check if Kiosker is running in the foreground. Returns a success message if the kiosk is active.

```APIDOC
## GET /ping

### Description
Ping the kiosk to check if Kiosker is running in the foreground.

### Method
GET

### Endpoint
/ping

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred (false for success).
- **function** (string) - The name of the function called (e.g., "ping").

#### Response Example
```json
{
  "error": false,
  "function": "ping"
}
```

#### Error Responses
- **401 Unauthorized**: Authentication failed.
- **403 IP Filtering failed**: IP address is not allowed to access the API.
```

--------------------------------

### GET /screensaver/state

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Retrieves the current state of the screensaver. This endpoint provides information on whether the screensaver is active or not.

```APIDOC
## GET /screensaver/state

### Description
Retrieves the current state of the screensaver. This endpoint provides information on whether the screensaver is active or not.

### Method
GET

### Endpoint
/screensaver/state

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred during the operation.
- **reason** (string) - Provides a reason for the error if `error` is true. (Schema indicates APIResponse, which includes 'reason')

#### Response Example
(Based on general APIResponse schema and context, a potential success response might look like this, though specific fields for screensaver state are not detailed in the provided snippet.)
```json
{
  "error": false,
  "screensaver_active": true 
}
```

#### Error Responses
- **401**: Authentication failed.
- **403**: IP Filtering failed.
```

--------------------------------

### Get Blackout State API

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Retrieves the current blackout state of the kiosk, including visibility, text, and background/foreground colors. Requires API token authentication. Returns a JSON object with blackout details or an error.

```json
{
  "/blackout/state": {
    "get": {
      "tags": [
        "Blackout"
      ],
      "summary": "Get the current blackout state",
      "description": "Get the current blackout state as set by /blackout.",
      "operationId": "getBlackoutState",
      "responses": {
        "200": {
          "description": "Successful operation",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/APIResponse"
              },
              "example": {
                "error": false,
                "function": "blackout/state",
                "blackout": {
                  "visible": true,
                  "text": "Kiosk Closed",
                  "background": "#000000",
                  "foreground": "#FFFFFF",
                  "expire": 86400
                }
              }
            }
          }
        },
        "401": {
          "description": "Authentication failed",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/APIResponse"
              },
              "example": {
                "error": true,
                "reason": "Unauthorized"
              }
            }
          }
        },
        "403": {
          "description": "IP Filtering failed",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/APIResponse"
              },
              "example": {
                "error": true,
                "reason": "IP Filtering failed"
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### GET /blackout/state

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Retrieves the current blackout state of the kiosk. This state is configured using the /blackout endpoint and can include visibility, text, background, and foreground colors, as well as an expiration time.

```APIDOC
## GET /blackout/state

### Description
Get the current blackout state as set by /blackout. This endpoint allows you to query the active blackout configuration, including whether it's visible, the text to display, color settings, and duration.

### Method
GET

### Endpoint
/blackout/state

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred.
- **function** (string) - The name of the function being called.
- **blackout** (object) - An object containing the blackout configuration:
  - **visible** (boolean) - Whether the blackout is currently active.
  - **text** (string) - The message to display when the blackout is active.
  - **background** (string) - The background color of the blackout message (hex format).
  - **foreground** (string) - The text color of the blackout message (hex format).
  - **expire** (integer) - The duration in seconds until the blackout expires.

#### Response Example
```json
{
  "error": false,
  "function": "blackout/state",
  "blackout": {
    "visible": true,
    "text": "Kiosk Closed",
    "background": "#000000",
    "foreground": "#FFFFFF",
    "expire": 86400
  }
}
```

#### Error Response (401)
- **error** (boolean) - Always true for errors.
- **reason** (string) - Description of the error, e.g., "Unauthorized".

#### Error Response (403)
- **error** (boolean) - Always true for errors.
- **reason** (string) - Description of the error, e.g., "IP Filtering failed".

```

--------------------------------

### Get Device Status API

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Retrieves the current status of the device, including battery level, OS version, and interaction timestamps. Requires API token authentication. Returns a JSON object with device details or an error if authentication/IP filtering fails.

```json
{
  "/status": {
    "get": {
      "tags": [
        "Device"
      ],
      "summary": "Get the current device status.",
      "description": "Get the current device status as set by /status.",
      "operationId": "getDeviceStatus",
      "responses": {
        "200": {
          "description": "Successful operation",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/APIResponse"
              },
              "example": {
                "error": false,
                "function": "status",
                "status": {
                  "batteryLevel": 65,
                  "batteryState": "Not Charging",
                  "model": "iPad",
                  "osVersion": "17.6",
                  "lastInteraction": "2021-12-01T10:00:00Z",
                  "lastMotion": null
                }
              }
            }
          }
        },
        "401": {
          "description": "Authentication failed",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/APIResponse"
              },
              "example": {
                "error": true,
                "reason": "Unauthorized"
              }
            }
          }
        },
        "403": {
          "description": "IP Filtering failed",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/APIResponse"
              },
              "example": {
                "error": true,
                "reason": "IP Filtering failed"
              }
            }
          }
        }
      }
    }
  }
}
```

--------------------------------

### POST /navigate/forward

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Navigates the website one step forward in the browsing history.

```APIDOC
## POST /navigate/forward

### Description
Navigates the website forward in the browsing history.

### Method
POST

### Endpoint
/navigate/forward

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred.
- **function** (string) - The name of the function executed.

#### Response Example
```json
{
  "error": false,
  "function": "navigate/forward"
}
```

#### Error Responses
- **401**: Authentication failed.
  - **reason** (string) - Reason for authentication failure.
- **403**: IP Filtering failed.
  - **reason** (string) - Reason for IP filtering failure.
```

--------------------------------

### POST /navigate/url - Navigate to URL

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Navigates the kiosk browser to a specified URL.

```APIDOC
## POST /navigate/url

### Description
Navigates the kiosk browser to a specified URL.

### Method
POST

### Endpoint
/navigate/url

### Parameters

#### Query Parameters

#### Request Body
- **url** (string) - Required - The URL to navigate to.

### Request Example
```json
{
  "url": "https://www.example.com"
}
```

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred.
- **function** (string) - The function that was executed.

#### Response Example
```json
{
  "error": false,
  "function": "navigate/url"
}
```

#### Error Responses
- **400**: Bad request (e.g., invalid URL format).
- **401**: Authentication failed.
- **403**: IP Filtering failed.
```

--------------------------------

### POST /print - Print Website

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Initiates a print job for the current website displayed in the kiosk browser.

```APIDOC
## POST /print

### Description
Initiates a print job for the current website displayed in the kiosk browser.

### Method
POST

### Endpoint
/print

### Parameters

#### Query Parameters

#### Request Body
This endpoint does not require a request body.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred.
- **function** (string) - The function that was executed.

#### Response Example
```json
{
  "error": false,
  "function": "print"
}
```

#### Error Responses
- **401**: Authentication failed.
- **403**: IP Filtering failed.
```

--------------------------------

### POST /navigate/backward - Navigate Backward

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Navigates the kiosk browser to the previous page in the history.

```APIDOC
## POST /navigate/backward

### Description
Navigates the kiosk browser to the previous page in the history.

### Method
POST

### Endpoint
/navigate/backward

### Parameters

#### Query Parameters

#### Request Body
This endpoint does not require a request body.

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred.
- **function** (string) - The function that was executed.

#### Response Example
```json
{
  "error": false,
  "function": "navigate/backward"
}
```

#### Error Responses
- **401**: Authentication failed.
- **403**: IP Filtering failed.
```

--------------------------------

### Screensaver Operations

Source: https://swagger.kiosker.io/index

Endpoints for managing the screensaver state and interaction.

```APIDOC
## POST /screensaver/interact

### Description
Simulates user interaction with the screensaver, potentially to prevent it from activating or to dismiss it.

### Method
POST

### Endpoint
/screensaver/interact

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - Indicates that screensaver interaction was simulated.

#### Response Example
```json
{
  "status": "success"
}
```

## GET /screensaver/state

### Description
Retrieves the current state of the Kiosker screensaver (e.g., whether it is active or inactive).

### Method
GET

### Endpoint
/screensaver/state

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **state** (string) - The current state of the screensaver (e.g., 'active', 'inactive').

#### Response Example
```json
{
  "state": "inactive"
}
```

## POST /screensaver/state

### Description
Sets the state of the Kiosker screensaver, potentially to activate or deactivate it.

### Method
POST

### Endpoint
/screensaver/state

### Parameters
#### Request Body
- **state** (string) - Required - The desired state for the screensaver ('active' or 'inactive').

### Request Example
```json
{
  "state": "active"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates that the screensaver state was successfully set.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Print Operations

Source: https://swagger.kiosker.io/index

Endpoint for printing the current website content.

```APIDOC
## POST /print

### Description
Initiates a print operation for the currently displayed website within the Kiosker application.

### Method
POST

### Endpoint
/print

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - Indicates the print operation was initiated successfully.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### POST /devices/url

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Updates the default URL for the kiosk device. This is the URL that the kiosk will navigate to upon startup or reset.

```APIDOC
## POST /devices/url

### Description
Updates the default URL for the kiosk device. This is the URL that the kiosk will navigate to upon startup or reset.

### Method
POST

### Endpoint
/devices/url

### Parameters
#### Request Body
- **url** (string) - Required - The URL to set as the default for the kiosk.

### Request Example
```json
{
  "url": "https://google.com"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the URL was updated successfully.

#### Response Example
```json
{
  "message": "URL updated successfully."
}
```
```

--------------------------------

### POST /navigate/refresh

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Refreshes the current website. This endpoint is useful for updating the displayed content.

```APIDOC
## POST /navigate/refresh

### Description
Refreshes the current website.

### Method
POST

### Endpoint
/navigate/refresh

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred.
- **function** (string) - The name of the function executed.

#### Response Example
```json
{
  "error": false,
  "function": "navigate/refresh"
}
```

#### Error Responses
- **401**: Authentication failed.
  - **reason** (string) - Reason for authentication failure.
- **403**: IP Filtering failed.
  - **reason** (string) - Reason for IP filtering failure.
```

--------------------------------

### Navigation Endpoints

Source: https://swagger.kiosker.io/index

Endpoints for controlling the navigation within the Kiosker application.

```APIDOC
## POST /navigate/home

### Description
Navigates the Kiosker application to the start or home page.

### Method
POST

### Endpoint
/navigate/home

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - Indicates the navigation was successful.

#### Response Example
```json
{
  "status": "success"
}
```

## POST /navigate/refresh

### Description
Refreshes the currently displayed website or page within the Kiosker application.

### Method
POST

### Endpoint
/navigate/refresh

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - Indicates the refresh was successful.

#### Response Example
```json
{
  "status": "success"
}
```

## POST /navigate/forward

### Description
Navigates the Kiosker application forward in the browsing history.

### Method
POST

### Endpoint
/navigate/forward

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - Indicates the forward navigation was successful.

#### Response Example
```json
{
  "status": "success"
}
```

## POST /navigate/backward

### Description
Navigates the Kiosker application backward in the browsing history.

### Method
POST

### Endpoint
/navigate/backward

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - Indicates the backward navigation was successful.

#### Response Example
```json
{
  "status": "success"
}
```

## POST /navigate/url

### Description
Navigates the Kiosker application to a specific URL.

### Method
POST

### Endpoint
/navigate/url

### Parameters
#### Request Body
- **url** (string) - Required - The URL to navigate to.

### Request Example
```json
{
  "url": "https://example.com"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the navigation to the URL was successful.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Screensaver State API

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Endpoints for checking and setting the screensaver state.

```APIDOC
## GET /screensaver/state

### Description
Check if screensaver is enabled or disabled.

### Method
GET

### Endpoint
/screensaver/state

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred.
- **function** (string) - The function called.
- **screensaver** (object) - Contains the screensaver status.
  - **disabled** (boolean) - True if screensaver is disabled, false otherwise.
  - **visible** (boolean) - True if screensaver is visible, false otherwise.

#### Response Example
```json
{
  "error": false,
  "function": "screensaver/state",
  "screensaver": {
    "disabled": true,
    "visible": false
  }
}
```

#### Error Response (401)
- **error** (boolean) - Indicates if an error occurred.
- **reason** (string) - The reason for the error.

#### Error Response Example (401)
```json
{
  "error": true,
  "reason": "Unauthorized"
}
```

#### Error Response (403)
- **error** (boolean) - Indicates if an error occurred.
- **reason** (string) - The reason for the error.

#### Error Response Example (403)
```json
{
  "error": true,
  "reason": "IP Filtering failed"
}
```

## POST /screensaver/state

### Description
Disable or enable the screensaver.

### Method
POST

### Endpoint
/screensaver/state

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **disabled** (boolean) - Required - Set to true to disable the screensaver, false to enable.

### Request Example
```json
{
  "disabled": true
}
```

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred.
- **function** (string) - The function called.

#### Response Example
```json
{
  "error": false,
  "function": "clear/cookies"
}
```

#### Error Response (401)
- **error** (boolean) - Indicates if an error occurred.
- **reason** (string) - The reason for the error.

#### Error Response Example (401)
```json
{
  "error": true,
  "reason": "Unauthorized"
}
```

#### Error Response (403)
- **error** (boolean) - Indicates if an error occurred.
- **reason** (string) - The reason for the error.

#### Error Response Example (403)
```json
{
  "error": true,
  "reason": "IP Filtering failed"
}
```
```

--------------------------------

### Device Status Schema

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Defines the schema for device status information, including battery level, battery state, model, OS version, and timestamps for last interaction and motion. Battery level is an integer percentage.

```json
{
  "components": {
    "schemas": {
      "DeviceStatus": {
        "type": "object",
        "properties": {
          "batteryLevel": {
            "type": "integer",
            "description": "The battery level as a percentage.",
            "examples": [
              65,
              80,
              20,
              75,
              100
            ]
          },
          "batteryState": {
            "type": "string",
            "description": "The state of the battery, such as charging, full, or unplugged.",
            "examples": [
              "Not Charging"
            ]
          },
          "model": {
            "type": "string",
            "description": "The model of the device.",
            "examples": [
              "iPad"
            ]
          },
          "osVersion": {
            "type": "string",
            "description": "The operating system version of the device.",
            "examples": [
              "17.6"
            ]
          },
          "lastInteraction": {
            "type": "string",
            "description": "The timestamp of the last interaction.",
            "format": "date-time"
          },
          "lastMotion": {
            "type": "string",
            "description": "The timestamp of the last detected motion.",
            "format": "date-time",
            "nullable": true
          }
        }
      }
    }
  }
}
```

--------------------------------

### Blackout Operations

Source: https://swagger.kiosker.io/index

Endpoints for disabling the kiosk display and checking its blackout state.

```APIDOC
## POST /blackout

### Description
Disables the kiosk display, effectively blacking out the screen.

### Method
POST

### Endpoint
/blackout

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - Indicates that the kiosk has been successfully disabled (blacked out).

#### Response Example
```json
{
  "status": "success"
}
```

## GET /blackout/state

### Description
Retrieves the current blackout state of the kiosk (whether the screen is disabled or not).

### Method
GET

### Endpoint
/blackout/state

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **isBlackedOut** (boolean) - True if the kiosk is currently blacked out, false otherwise.

#### Response Example
```json
{
  "isBlackedOut": false
}
```
```

--------------------------------

### Status Endpoints

Source: https://swagger.kiosker.io/index

Endpoints for checking the status and health of the Kiosker application.

```APIDOC
## GET /ping

### Description
Ping the kiosk to check if it is responsive.

### Method
GET

### Endpoint
/ping

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating the kiosk is reachable.

#### Response Example
```json
{
  "message": "pong"
}
```

## GET /status

### Description
Get the current status of the Kiosker application, including device information and operational state.

### Method
GET

### Endpoint
/status

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **appVersion** (string) - The current version of the Kiosker application.
- **appName** (string) - The name of the Kiosker application.
- **ambientLight** (number) - The current ambient light level detected by the device.
- **deviceStatus** (object) - Contains detailed status information about the device.
    - **isLocked** (boolean) - Indicates if the device is currently locked.
    - **isScreenOn** (boolean) - Indicates if the device screen is on.
    - **networkStatus** (string) - The current network status (e.g., 'connected', 'disconnected').

#### Response Example
```json
{
  "appVersion": "25.9.1 (236)",
  "appName": "Kiosker Pro",
  "ambientLight": 150,
  "deviceStatus": {
    "isLocked": false,
    "isScreenOn": true,
    "networkStatus": "connected"
  }
}
```
```

--------------------------------

### POST /devices/blackout

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Applies a blackout screen to the kiosk device. This can be used for scheduled maintenance or temporary closures.

```APIDOC
## POST /devices/blackout

### Description
Applies a blackout screen to the kiosk device. This can be used for scheduled maintenance or temporary closures.

### Method
POST

### Endpoint
/devices/blackout

### Parameters
#### Request Body
- **visible** (boolean) - Required - Set to true to activate the blackout screen.
- **text** (string) - Optional - The text to display on the blackout screen. If null, no text will be shown.
- **background** (string) - Optional - The background color of the blackout screen in HEX format (e.g., "#000000"). If null, the default background will be used.
- **foreground** (string) - Optional - The foreground color (text color) of the blackout screen in HEX format (e.g., "#FFFFFF"). If null, the default text color will be used.
- **icon** (string) - Optional - The name of the icon to display on the blackout screen (e.g., "wrench.and.screwdriver.fill"). If null, no icon will be shown.
- **expire** (integer) - Optional - The duration in seconds after which the blackout screen will automatically expire. If null, the blackout screen will remain active until manually removed.

### Request Example
```json
{
  "visible": true,
  "text": "Kiosk Closed",
  "background": "#000000",
  "foreground": "#FFFFFF",
  "icon": "wrench.and.screwdriver.fill",
  "expire": 3600
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the blackout screen has been applied.

#### Response Example
```json
{
  "message": "Blackout screen applied successfully."
}
```
```

--------------------------------

### API Response Schema

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Defines the standard structure for API responses, including boolean error flags, reasons for errors, and specific data payloads for functions like status or blackout. Supports nullable fields.

```json
{
  "components": {
    "schemas": {
      "APIResponse": {
        "type": "object",
        "properties": {
          "error": {
            "type": "boolean",
            "examples": [
              false
            ]
          },
          "reason": {
            "type": "string",
            "nullable": true,
            "examples": [
              null
            ]
          },
          "function": {
            "type": "string",
            "nullable": true,
            "examples": [
              "status"
            ]
          },
          "status": {
            "$ref": "#/components/schemas/DeviceStatus"
          },
          "blackout": {
            "$ref": "#/components/schemas/APIBodyBlackout",
            "examples": [
              null
            ]
          },
          "screensaver": {
            "$ref": "#/components/schemas/APIBodyScreensaver",
            "examples": [
              null
            ]
          }
        }
      }
    }
  }
}
```

--------------------------------

### Blackout API

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Endpoint for disabling the kiosk for maintenance.

```APIDOC
## POST /blackout

### Description
Disable the kiosk for maintenance or for other reasons.

### Method
POST

### Endpoint
/blackout

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **visible** (boolean) - Mandatory - Indicates if the screen should be visible (false for blackout).
- **expires** (string) - Optional - Expiration time for the blackout (e.g., "24h"). If omitted, defaults to 24 hours.

### Request Example
```json
{
  "visible": false,
  "expires": "48h"
}
```

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred.
- **function** (string) - The function called.

#### Response Example
```json
{
  "error": false,
  "function": "blackout"
}
```

#### Error Response (400)
- **error** (boolean) - Indicates if an error occurred.
- **reason** (string) - The reason for the error.

#### Error Response Example (400)
```json
{
  "error": true,
  "reason": "Bad Request"
}
```

#### Error Response (401)
- **error** (boolean) - Indicates if an error occurred.
- **reason** (string) - The reason for the error.

#### Error Response Example (401)
```json
{
  "error": true,
  "reason": "Unauthorized"
}
```
```

--------------------------------

### POST /devices/screensaver

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Configures the screensaver settings for the kiosk device. You can enable or disable the screensaver and set its visibility.

```APIDOC
## POST /devices/screensaver

### Description
Configures the screensaver settings for the kiosk device. You can enable or disable the screensaver and set its visibility.

### Method
POST

### Endpoint
/devices/screensaver

### Parameters
#### Request Body
- **disabled** (boolean) - Required - Set to true to disable the screensaver, false to enable.
- **visible** (boolean) - Optional - Set to true to make the screensaver visible, false to hide. If null, the default behavior will be used.

### Request Example
```json
{
  "disabled": false,
  "visible": true
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the screensaver settings were updated.

#### Response Example
```json
{
  "message": "Screensaver settings updated successfully."
}
```
```

--------------------------------

### POST /clear/cache

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Clears the browser cache and associated data. This can resolve issues related to outdated cached content.

```APIDOC
## POST /clear/cache

### Description
Clears the browser cache and associated data. This can resolve issues related to outdated cached content.

### Method
POST

### Endpoint
/clear/cache

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred during the operation.
- **function** (string) - The name of the function that was executed.

#### Response Example
```json
{
  "error": false,
  "function": "clear/cache"
}
```

#### Error Responses
- **401**: Authentication failed.
- **403**: IP Filtering failed.
```

--------------------------------

### Clear Data Operations

Source: https://swagger.kiosker.io/index

Endpoints for clearing cookies, cache, and data from the Kiosker application.

```APIDOC
## POST /clear/cookies

### Description
Clears all stored cookies within the Kiosker application.

### Method
POST

### Endpoint
/clear/cookies

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - Indicates that cookies were cleared successfully.

#### Response Example
```json
{
  "status": "success"
}
```

## POST /clear/cache

### Description
Clears the cache and stored data for the Kiosker application.

### Method
POST

### Endpoint
/clear/cache

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **status** (string) - Indicates that cache and data were cleared successfully.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### POST /screensaver/interact

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Simulates a user interaction, such as a screen touch, to dismiss the screensaver. This action does not affect idle timers or browsing time limits.

```APIDOC
## POST /screensaver/interact

### Description
Simulates a user interaction, such as a screen touch, to dismiss the screensaver. This action does not affect idle timers or browsing time limits.

### Method
POST

### Endpoint
/screensaver/interact

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred during the operation.
- **function** (string) - The name of the function that was executed. (Note: Example shows "clear/cookies" but likely intended to reflect screensaver interaction)

#### Response Example
```json
{
  "error": false,
  "function": "clear/cookies"
}
```

#### Error Responses
- **401**: Authentication failed.
- **403**: IP Filtering failed.
```

--------------------------------

### API Security Scheme

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Defines the 'apiToken' security scheme using HTTP Bearer authentication. This scheme is used to secure API endpoints by requiring an access token obtained from the Kiosker App.

```json
{
  "components": {
    "securitySchemes": {
      "apiToken": {
        "type": "http",
        "scheme": "bearer",
        "description": "Get the API access token from the Kiosker App."
      }
    }
  }
}
```

--------------------------------

### POST /clear/cookies

Source: https://swagger.kiosker.io/api/kiosker_1_2_0

Clears all cookies stored by the Kiosker. This is useful for resetting session data.

```APIDOC
## POST /clear/cookies

### Description
Clears all cookies stored by the Kiosker. This is useful for resetting session data.

### Method
POST

### Endpoint
/clear/cookies

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **error** (boolean) - Indicates if an error occurred during the operation.
- **function** (string) - The name of the function that was executed.

#### Response Example
```json
{
  "error": false,
  "function": "clear/cookies"
}
```

#### Error Responses
- **401**: Authentication failed.
- **403**: IP Filtering failed.
```
Tokens:
Raw