IDTech API: Requirements

To run successfully, this sample demo requires the following:

Kiosk Pro Enterprise, version 7.8 or later

While the JavaScript included in this code sample is compatible with earlier versions of Kiosk Pro, those versions require a different 'kiosk_functions.js' file to access this functionality.

For live projects, we highly recommend hosting the 'kiosk_functions.js' file with your own files, whether they are placed on a server or stored locally on the iPad, and checking the app's change logs before updating. The 'kiosk_functions.js' file referenced in the sample may be updated or moved without warning - if you are referencing this file directly, this would prevent your kiosks from working correctly.

To run the demo on earlier versions of the app, generate the 'kiosk_functions.js' for that version from the settings menu under 'JavaScript API > Generate API Functions File'. Transfer the file from the device using iTunes so you can place it where you need it, then change the reference in the sample code to point at the file.

Connection to a Supported IDTech Card Reader

Kiosk Pro integrates the SDK for four specific IDTech card readers - the iMag Pro and iMag Pro II, which use Apple's 30-pin or Lightning connector (depending on the iPad model being used), and the UniMag II and Shuttle, which both use the audio jack.

If using an unencrypted reader, this approach returns the information from a card swipe as plain text directly to your HTML page through a JavaScript function. We generally recommend using these unencrypted card readers for cards that do not contain sensitive information, like loyalty or membership cards.

If using an encrypted reader, this API returns the information as both a masked plain-text string and an encrypted string. In this scenario, you would be responsible for sending and decrypting the string.

For more information about the IDTech card readers supported, visit IDTechProducts.com.

Specific Volume Settings (audio jack card readers only)

If using a reader that uses the audio jack, you must make sure that the volume to the headphone jack is at the maximum possible level and that the physical lock switch is not set to mute the device.

Specific Kiosk Pro Settings

Shuttle & UniMag II Demo iMag Pro & iMag Pro II Demo