Our Capture APIs allow you to save form data, take a photo or video with the device's native camera, and capture screenshots. All information is stored locally on the on the device in the Kiosk Pro Documents folder.
Using these APIs, you can run a survey or sign-up form in an area with poor or non-existent WiFi and/or cellular data connection and then retrieve the data later. The resulting data and/or files can be pulled from the iPad through a local sync directly with iTunes, or a remote sync through our Dropbox integration.
Our Display APIs allow you to share content full-screen on a connected external monitor or display, using the iPad as the controller.
Our Locate APIs allow you to pull geolocation data from the device and add iBeacon support, allowing you to create contextual, location-specific experiences for visitors.
Our Print APIs allow you more control over you how you print content from Kiosk Pro, including the ability to print to Star Micronics and Custom America thermal printers and AirPrint-enabled printers.
Our Scanning APIs allow you to scan barcodes and QR codes using the device’s native cameras, an Aila scanner, or if you don't need visitor access to the on-screen keyboard, through an external Bluetooth scanner.
Our Swipe APIs allow you to accept magnetic stripe card swipes through a variety of card readers. If you are based in the US, this API also allows you to send fully-encrypted credit card swipes to MercuryPay for secure PCI-compliant credit card processing.
- By Import (Available Online & Offline) - default for Enterprise
- By Injection (Available Offline Only)
- Never - default for Basic & Plus
By Import (Available Online & Offline)
This has the advantage of ensuring that all hooks are loaded and ready to go when the window.onload call is triggered, which can increase reliability and simplify coding of functions that are called automatically on page load. It also means that you can just include these functions on pages where they are being used, which should speed loading of other pages.
To use this method, you will need to include 'kiosk_functions.js', referencing it as an external script in each page prior to any other external .js files or scripts that rely on these functions. To generate the latest version of 'kiosk_functions.js' compatible with the version of the app you are currently running, go to the 'Generate API Functions File' setting.
By Injection (Available Offline Only)
This is also the only option if you do not have direct access to add the 'kiosk_functions.js' file to each page and need access to these functions.
Our Availability API checks if the API is available before trying to call other API functions. Documentation is available here.
Generate API Functions File
To generate the file, tap 'Create kiosk_functions.js' in the top right of the panel. The file will be created and stored in the Kiosk Pro Documents folder.
If your project is stored locally on the device, you can leave the file in the Documents folder and reference it with a relative URL from that location.
If your project is hosted online, you'll need to pull the file from the Documents folder (instructions on how to transfer files to and from the device here) and host it with the other files on your server. (For security reasons, Apple doesn't make it possible for remotely stored webpages to access locally stored files or other assets.)