The ParseLink localhost API is only supported on ParseLink version 2.26 or greater.
Installation and Licensing
-
Download and install ParseLinkSetup.msi version 2.26 or greater.
-
Download and install the latest Authentication SDK from our downloads page.
- Follow the ParseLink Device Licensing steps to activate your license.
Configuration
We recommend disabling all non-essential functions of ParseLink for use with the localhost API. This will prevent keyboard emulation and prevent any files from being saved locally on the machine.
Right-click the PL icon in the system tray and uncheck these three checkboxes in the main section of the menu:
|
 |
Enable the Authentication SDK
Ensure the Authentication SDK is installed on your machine before launching ParseLink to enable the Authentication SDK.
|
Right-click the PL icon in the system tray and navigate to:
Enable the checkbox for ☑ Authentication Engine. If the checkbox is disabled, try to relaunch ParseLink after the latest Authentication SDK has finished installing and try again.
Optional: Enable the checkbox for ☑ Hide popup for "Passed" IDs to prevent ParseLink from showing a popup if the scan status is Passed to prevent interruptions if needed.
Click the Close button and the Authentication SDK will initialize. |
 |
Enable the ParseLink LocalHost Service
Right-click the PL icon in the system tray and navigate to:
-
System Tray Menu > Settings > ☑ LocalHost API
Enable the checkbox for ☑ LocalHost API to start the localhost service.
Testing the LocalHost API
You can access the Swagger UI to access the included methods and schemas:
-
https://localhost:5000/swagger/index.html
Methods
- https://localhost:5000/parselink/scan
- https://localhost:5000/parselink/scan{ipAddress}
- https://localhost:5000/parselink/state
Schemas
- AuthenticationGroupModel
- AuthenticationModel
- ErrorModel
- ImageModel
- ScanModel
- StateModel