JavaScript API

Kiosk Pro’s JavaScript API allows you to unlock the full potential of your kiosk.

From communicating with kiosk peripherals like thermal printers and card readers to accessing the iPad’s cameras to take photos or scan a barcode, the API provides an easy-to-implement set of JavaScript calls you can use in your code.

A Tower model kiosk, which securely encloses an iPad and an external LCD screen.

Display APIs

Our Display APIs allow you to connect to an external monitor to display content on a large-format screen.

Learn More

Basic
Plus
Enterprise

Send content full-screen to an external display through Apple’s Digital AV Adapter or over AirPlay to a connected AppleTV
Play and/or loop video files
Display image files, .pdf & .html pages
Switch as needed between full-screen & native mirroring
Can be used in combination with the standard 'Screensaver’ feature
Send separate audio tracks through external display speakers

Capture APIs

Our Capture APIs allow you to save form data, screen capture images, or capture photos/videos with the nativa camera, then store the result locally on the device in the Kiosk Pro documents folder.

An iPad with a form on-screen.

Basic
Plus
Enterprise
Documentation

Save form data locally to the device
Capture visitor signatures or drawings
Capture full screenshots
Use the iPad's front or rear camera to take photos/videos triggered by visitor or with an automatic countdown
Connect to other apps using our Zapier integration

Swipe APIs

Our Swipe APIs allow you to accept magnetic stripe card swipes through a variety of card readers.

Supported Card Readers
A kiosk with a card reader attached; a credit card is inserted in the reader.

Basic
Plus
Enterprise
Documentation

Return card swipe data from an IDTech Shuttle or UniMag II audio jack card reader
Return card swipe data from an IDTech iMag Pro (30-pin) or iMag Pro II (Lightning connector) card reader
Return card swipe data from an MagTek iDynamo card reader

Scan APIs

Our Scan APIs allow you to scan barcodes & QR codes using the device’s native front or back cameras.

If used on a project that doesn’t need access to the native on-screen keyboard, you can also access data through a connected Bluetooth barcode scanner or Aila Scanner.

Supported Scanners
An iPad with the native camera capture open, scanning a QR code on an ID.

Basic
Plus
Enterprise
Documentation

Use the iPad's front or rear camera to scan UPC barcodes & QR codes
Scan barcodes & QR codes from a Bluetooth barcode scanner
Scan barcodes & QR codes from an Aila scanner

Print APIs

Our Print APIs allow you more control over you how you print content from Kiosk Pro, including the ability to print to Star Micronics & Custom America printers.

Supported Printers
A Standalone kiosk with a printer box attachment.

Basic
Plus
Enterprise
Documentation

Print to an AirPrint enabled printer using JavaScript
Print to a Star Micronics thermal printer
Print to a Custom America thermal printer

Trigger APIs

Our Trigger APIs allow you to trigger specific kiosk functions and manage locally stored content through custom JavaScript calls.

Basic
Plus
Enterprise
Documentation

Pause &/or trigger Kiosk Pro’s idle timer
Clear the cache & cookies
Check the status of Dropbox sync
Manage local files
Manage a user session in the Remote Management Server
Form submission when using autofill of username & password
Delay refresh of the homepage when a remote content or settings update occurs.

Access APIs

Our Access APIs allow you to access information about the current state of each kiosk device and to access the Unique iPad ID set in Kiosk Pro settings.

Basic
Plus
Enterprise
Documentation

Check if Kiosk Pro’s JavaScript API is available to be called
Control your content based on the device’s orientation
Access the Unique iPad ID or Group IDs set in Kiosk Pro settings
Check which app version and version number of Kiosk Pro is currently running
Access the location coordinates of your device

Customize through app settings

Kiosk Pro’s settings menu allows you to easily customize how your content is presented.

Learn More
An iPad showing the Kiosk Pro settings menu.