Access API: What's Included

Determine which version of Kiosk Pro is being used

Supported in:

These API calls allow you to check which version of Kiosk Pro you are currently running, including the app name (for example, Kiosk Pro Plus) and the version number (for example, 6.8.1). This information can be useful if you are deploying a new API call that may not be supported across all kiosks in your deployment or can be used for troubleshooting.

View Documentation & Sample Code

Access the Unique iPad ID and Group IDs set in Kiosk Pro settings

Supported in:

Kiosk Pro allows you to reference the Unique iPad ID set for your kiosk within Kiosk Pro settings by setting it as a JavaScript variable as the page is loading.

This lets you identify which kiosk is requesting a page or to tag form data with the ID of the sending kiosk. Checking for a unique ID can also provide a quick way of determining whether a visitor is accessing a site through Kiosk Pro (as opposed to a regular web browser).

View Documentation & Sample Code

Control your content based on the device’s orientation

Supported in:

This callback uses information sent from the device’s accelerometer to inform your code of the current orientation of the device. This is triggered automatically by the app on page load and after any change in the device’s orientation.

View Documentation & Sample Code

Check the status of Guided Access or Single App Mode

Supported in:

You can check if Guided Access or Single App Mode are enabled.

View Documentation & Sample Code

Determine if device is currently using VoiceOver accessibility

Supported in:

VoiceOver is a native iOS gesture-based screen reader that lets visitors engage with your content even if they can't see the screen. When enabled, VoiceOver provides an audio description of everything happening on the screen, allowing visitors with visual impairments to navigate and engage with content.

VoiceOver is an iOS system level setting and cannot currently be enabled and/or disabled programmatically by the app.

View Documentation & Sample Code

Check current battery status and level

Supported in:

This set of API calls allows you to check the current status of the battery and returns callbacks when charging status or battery levels change.

View Documentation & Sample Code

Check if the JavaScript API is available to be called

Supported in:

The custom JavaScript functions Kiosk Pro uses in its JavaScript API must be loaded before they can be called by your code. If you are accessing the JavaScript API by import as recommended, all functions will be loaded into the page prior to the ‘onload’ event and will thereafter be available at any time.

If you choose to access the JavaScript API by injection, it may not be fully loaded when the ‘onload’ event is triggered and in this case we recommend using these functions to determine when it is safe for your code to call an API function.

Note that accessing the API by Injection has been deprecated in version 10.0 and is not recommended for new projects as it may be removed in a later release.

View Documentation & Sample Code