Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:server_api [2018/09/10 10:25]
kkshin
en:server_api [2023/03/08 09:14] (current)
Line 3: Line 3:
 API that can enable server matching or controls the device from the BioStar application. \\ API that can enable server matching or controls the device from the BioStar application. \\
 <callout type="​warning"​ icon="​true"><​WRAP em>​Warning</​WRAP>​ \\ <callout type="​warning"​ icon="​true"><​WRAP em>​Warning</​WRAP>​ \\
-<wrap hi>​BioMini&​Image SDK License Error : Invalid Verification!</​wrap> ​\\ +Due to the issues with the management of UFMatcher.dll which was provided by a separate independent Corporation,​​ Runnable examples will not be available anymore. ​\\  
-This is the Suprema license key you need in order to use server matching feature. \\ +Please reference ​the prior examples at the code level only\\ \\  
-Once you receive "​UFLicense.lic"​ file, you need to activate them using "​activate_lic.exe"​ file. \\ +Other technical supports including libraries for server matching can be provided by SupremaID ​sales team. \\  
-Suprema ID sales team will give you further instruction on this. \\ +<wrap hi>Suprema ID : sales_id@supremainc.com</​wrap>​ \\ 
-Suprema ID: sales_id@supremainc.com+</​callout>​
  
-Once you activate the license, please copy this "​UFLicense.lic"​ file into BioStar 2 device SDK folder. \\ +  ​* [[BS2_SetServerMatchingHandler]]: ​Registers ​the server matching handler.
-The BioStar 2 device SDK version you received, you will find "​example"​ folder there. \\ +
-Please try to copy the license file to example folder (Example > cli > csharp > common > lib > x86) and see if can use server matching.</​callout>​ +
- +
-  ​* [[BS2_SetServerMatchingHandler]]: ​Configures ​the server matching handler.+
   * [[BS2_VerifyUser]]:​ Transfers user information mapped to the card or user ID authentication results to the device.   * [[BS2_VerifyUser]]:​ Transfers user information mapped to the card or user ID authentication results to the device.
   * [[BS2_IdentifyUser]]:​ Transfers user information mapped to the fingerprint authentication results to the device.   * [[BS2_IdentifyUser]]:​ Transfers user information mapped to the fingerprint authentication results to the device.
-  * [[BS2_VerifyUserEx]]:​ Transfers user information mapped to the card or user ID authentication results to the device. ​(Applies only for v2.4 FW group) +  * [[BS2_VerifyUserEx]]: ​[+ 2.4.0] ​Transfers user information mapped to the card or user ID authentication results to the device. ​ 
-  * [[BS2_IdentifyUserEx]]: Transfers user information mapped to the fingerprint authentication results to the device. ​(Applies only for v2.4 FW group)+  * [[BS2_IdentifyUserEx]]:​ [+ 2.4.0] Transfers user information mapped to the fingerprint authentication results to the device. ​ 
 +  * [[BS2_VerifyUserSmall]]: [+ 2.6.3] Transfers user information mapped to the card or user ID authentication results to the device. 
 +  * [[BS2_IdentifyUserSmall]]:​ [+ 2.6.3] ​Transfers user information mapped to the fingerprint authentication results to the device. 
 +  * [[BS2_VerifyUserSmallEx]]:​ [+ 2.6.3] Transfers user information mapped to the card or user ID authentication results to the device. 
 +  * [[BS2_IdentifyUserSmallEx]]:​ [+ 2.6.3] Transfers user information mapped to the fingerprint authentication results to the device. 
 +  * [[BS2_VerifyUserFaceEx]]:​ [+ 2.7.2] Transfers user information mapped to the card or user ID authentication results to the device. 
 +  * [[BS2_SetUserPhraseHandler]]:​​ [+ 2.7.0] Registers the server user phrase handler. 
 +  * [[BS2_ResponseUserPhrase]]:​​ [+ 2.7.0] Transfers the user phrase to the device. 
 +  * [[BS2_SetOsdpStandardDeviceStatusListener]]:​ [+ 2.9.1] Register a listener function that detects state changes of the OSDP device.
 ===== Callback Function ====== ===== Callback Function ======
 <code cpp> <code cpp>
Line 27: Line 31:
 2. //​OnIdentifyUser//​ \\  2. //​OnIdentifyUser//​ \\ 
 Callback function that is called when the BioStar application needs to distinguish whether the fingerprint matches. \\  Callback function that is called when the BioStar application needs to distinguish whether the fingerprint matches. \\ 
 +
 +\\
 +
 +==== OnUserPhrase ====
 +Callback function asking for user phrase to the server.
 +<code cpp>
 +typedef void (*OnUserPhrase)(uint32_t deviceId, uint16_t seq, const char* userID);
 +</​code>​
 +\\
 +
 +1. //​deviceId//​ \\ 
 +Device ID  \\ \\ 
 +2. //seq// \\ 
 +Packet sequence ​ \\ \\ 
 +3. //userID// \\ 
 +User ID  \\ \\ 
 +
 +==== OnBarcodeScanned ====
 +Callback function called when barcode is scanned on the device. \\ \\ 
 +<code cpp>
 +typedef void (*OnBarcodeScanned)(uint32_t deviceId, const char* barcode);
 +</​code>​
 +\\
 +1. //​deviceId//​ \\ 
 +Device ID that sent the scanned barcode. ​ \\ \\ 
 +2. //barcode// \\ 
 +Barcode string read from device. ​ \\ \\ 
 +
 +
 +==== OnOsdpStandardDeviceStatusChanged ====
 +This is a callback function that is called when the state of the OSDP device changes. ​ \\ \\ 
 +<code cpp>
 +typedef void (*OnOsdpStandardDeviceStatusChanged)(uint32_t deviceId, const BS2OsdpStandardDeviceNotify* notifyData);​
 +</​code>​
 +\\
 +1. //​deviceId//​ \\ 
 +OSDP device identifier. ​ \\ \\ 
 +2. //​notifyData//​ \\ 
 +OSDP device information. ​ \\ \\