SwipeTrack Browser API Revision 2.0.0 SwipeTrack Browser API Table of Contents Table of Contents Introduction .................................................................................................................................................. 4 Release Notes .......................................................................................................................................................... 4 Supported Devices ........................................................................................................................................ 5 Barcode Readers & Magnetic Stripe Readers (MSR) .................................................................................................. 5 Printers .................................................................................................................................................................... 5 Radio Frequency Identification (RFID) Readers ......................................................................................................... 5 JavaScript Interface ....................................................................................................................................... 6 Barcode Reader Functions ........................................................................................................................................ 6 stBrowserDidScanBarcode ................................................................................................................................ 6 Magnetic Stripe Reader (MSR) Functions .................................................................................................................. 6 stBrowserDidReadCardData .............................................................................................................................. 6 stBrowserDidReadEncryptedCardData ........................................................................................................ 6 stBrowserDidReadFinancialCardData ........................................................................................................ 7 Radio Frequency Identification (RFID) Functions ....................................................................................................... 7 stBrowserDidDetectRFCard .............................................................................................................................. 7 stBrowserDidReadRFCard ................................................................................................................................... 7 stBrowserDidReadRFCard ................................................................................................................................... 8 stBrowserShouldCloseRFCardOnDetect ...................................................................................................... 8 Miscellaneous Functions .......................................................................................................................................... 9 stBrowserDidCapturePicture ......................................................................................................................... 9 stBrowserDidCaptureSignature .................................................................................................................... 9 URI ScHeme ................................................................................................................................................. 10 Barcode Reader Functions ...................................................................................................................................... 10 stBrowser://startBarcodeScanner ........................................................................................................... 10 stBrowser://startCameraScanner .............................................................................................................. 10 stBrowser://stopBarcodeScanner .............................................................................................................. 10 stBrowser://stopCameraScanner ................................................................................................................ 10 Browser Functions .................................................................................................................................................. 11 stBrowser://capturePicture ....................................................................................................................... 11 stBrowser://captureSignature .................................................................................................................. 11 stBrowser://clearCredentials .................................................................................................................. 11 stBrowser://closeTab ..................................................................................................................................... 11 stBrowser://getAppSettings?callback=@CALLBACK .......................................................................... 12 stBrowser://getLastLaunchedTime?callback=@CALLBACK .............................................................. 12 stBrowser://openTab?url=@URL .................................................................................................................. 12 stBrowser://playSound?sound=@SOUND .................................................................................................... 12 stBrowser://quitApplication?msg=@MSG ............................................................................................... 13 stBrowser://setAddressBarHidden?hidden=@HIDDEN ........................................................................ 13 stBrowser://setAppSettings?settings=@SETTINGS .......................................................................... 13 stBrowser://setHomePage?page=@PAGE .................................................................................................... 13 stBrowser://setNavigationBarHidden?hidden=@HIDDEN ................................................................ 13 stBrowser://vibrateDevice?count=@COUNT ........................................................................................... 14 Print Functions ....................................................................................................................................................... 14 stBrowser://printHtml?html=@HTML ......................................................................................................... 14 stBrowser://printText?text=@TEXT ......................................................................................................... 14 stBrowser://printHtml?url=@URL .............................................................................................................. 14 Revision 2.0.0 2 SwipeTrack Browser API Table of Contents Radio Frequency Identification (RFID) Functions ..................................................................................................... 14 stBrowser://closeRFCard?index=@INDEX ............................................................................................... 14 stBrowser://readRFCard?index=@INDEX&addr=@ADDR&len=@LEN .................................................. 15 stBrowser://readRFCard?index=@INDEX&app=@APP&file=@FILE&len=@LEN ............................. 15 Reference .................................................................................................................................................... 16 Table 1: Barcode Type Enumeration ....................................................................................................................... 16 Table 2: Magnetic Card Encryption Type Enumeration ............................................................................................ 17 Table 3: RFID Card Type Enumeration ..................................................................................................................... 17 Table 4: Browser Settings Object Properties ........................................................................................................... 17 Table 5: Browser Sound Files .................................................................................................................................. 18 Table 6: Encrypted Magnetic Card Properties ......................................................................................................... 18 Revision 2.0.0 3 SwipeTrack Browser API Introduction Introduction This document outlines how to integrate a website with the SwipeTrack Browser API. The API outlined in this document allows websites that implement it to communicate with supported hardware devices through the SwipeTrack Browser application. Release Notes Version Date Changes 1.0.0 5/20/2014 Initial document release 1.0.1 6/12/2014 Added the section on User Defined Callbacks 1.0.2 7/15/2014 Added “stBrowser://printURL?url=@URL” function Added Star Micronics TSP100 to supported devices list Deprecated “stBrowser://airPrint?url=@URL” function 1.0.3 8/26/2014 Added methods for capturing a user signature Added “msrRawEncryptionData” to Table 5 1.1.0 12/23/2014 Added “stBrowserCacheStoragePolicy” to Table 4 1.1.1 1/6/2015 Added methods for capturing a picture 1.1.2 1/29/2015 Updated Supported Devices list Updated “stBrowser://printBarcode” function with new printer support 2.0.0 2/28/2017 Rebuilt document for release of SwipeTrack Browser v6.0.0