API: Check Status of Autofill
These JavaScript API callbacks allow you to verify that Kiosk Pro successfully autofilled a username & password pair for a specific URL and can also be used to immediately trigger submission after a form is autofilled.
Requirements
- Integration of our JavaScript API into your webpage
- Sample code to run within the app and download for integration into your own project is available here.
- Best practices for working with the JavaScript API are available here.
- App Settings
- Content > JavaScript API > Access JavaScript API = By Import
- Autofill Usernames & Passwords >
- Enable = On
- Group 1 >
- Matched URLs = configured
- Username = configured
- Password = configured
- Username Field Identifier = configured
- Password Field Identifier = configured
Notifications via API Callbacks
On Successful Autofill
This callback is triggered when Kiosk Pro has successfully autofilled a username & password on a matched page.
| Format |
kp_Autofilling_didSuccessfullyFillUsingGroup(groupURL, numberOfGroup, numberOfAllGroups, loginId, loginValue, passwordId);
|
| Return values |
- groupURL - [string] the URL configured in Kiosk Pro settings that matched the current page. If multiple URLs match, they will be included, separated by semicolons
- numberOfGroup - [string] the number of current username/password pair. This will always be '1' unless you've defined multiple username/password pairs on the same matched URL
- numberOfAllGroups - [string] the total number of matched username/password pairs on the current page. When numberOfGroup == numberOfAllGroups, Kiosk Pro has completed all available autofilling
- loginId - [string] the ID of login element provided in Kiosk Pro settings
- loginValue - [string] the value of login element provided in Kiosk Pro settings
- passwordId - [string] the ID of password element provided in Kiosk Pro settings
- Note: The API does not pass the password value for security reasons.
|
On Failure to Match URL
This callback is triggered when Kiosk Pro has not found a URL in Autofill settings that matches the current page, indicating that there is not a username/password pair available for this page or that the Autofill settings have been incorrectly configured.
| Format |
kp_Autofilling_didFailMatchingUsingGroupURL(groupURL, numberOfGroup, numberOfAllGroups, loginId, loginValue, passwordId);
|
| Return values |
- groupURL - [string] the URL configured in Kiosk Pro settings that matched the current page. If multiple URLs match, they will be included, separated by semicolons
- numberOfGroup - [string] the number of current username/password pair. This will always be '1' unless you've defined multiple username/password pairs on the same matched URL
- numberOfAllGroups - [string] the total number of matched username/password pairs on the current page. When numberOfGroup == numberOfAllGroups, Kiosk Pro has completed all available autofilling
- loginId - [string] the ID of login element provided in Kiosk Pro settings
- loginValue - [string] the value of login element provided in Kiosk Pro settings
- passwordId - [string] the ID of password element provided in Kiosk Pro settings
- Note: The API does not pass the password value for security reasons.
|
On Failure to Fill Username/Password for a Matched URL
This callback is triggered when Kiosk Pro matches a URL configured in Kiosk Pro settings to the current page, but is unable to successfully identify the username and/or password field based on the information provided.
| Format |
kp_Autofilling_didFailFillUsingGroup(groupURL, numberOfGroup, numberOfAllGroups, loginId, loginValue, passwordId);
|
| Return values |
- groupURL - [string] the URL configured in Kiosk Pro settings that matched the current page. If multiple URLs match, they will be included, separated by semicolons
- numberOfGroup - [string] the number of current username/password pair. This will always be '1' unless you've defined multiple username/password pairs on the same matched URL
- numberOfAllGroups - [string] the total number of matched username/password pairs on the current page. When numberOfGroup == numberOfAllGroups, Kiosk Pro has completed all available autofilling
- loginId - [string] the ID of login element provided in Kiosk Pro settings
- loginValue - [string] the value of login element provided in Kiosk Pro settings
- passwordId - [string] the ID of password element provided in Kiosk Pro settings
- Note: The API does not pass the password value for security reasons.
|
Sample Code
- This sample code relies on the JavaScript APIs built into Kiosk Pro and will not run successfully in other browsers or within our in-app help interface.
- To run sample code, set the app's homepage to kioskgroup.com/autofill-api
- To download a .zip of sample code, click here.
Change Log
- Added to Enterprise in version 6.0. Added to Plus in version 6.6.
