Differences

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

--- en:server_api [2017/03/21 11:31]
127.0.0.1 external edit
+++ en:server_api [2020/07/29 15:09]
yjjung [Server API]
@@ Line 2: / Line 2: @@
 API that can enable server matching or controls the device from the BioStar application. \\
+<callout type="warning" icon="true"><WRAP em>Warning</WRAP> \\
+<wrap hi>BioMini&Image SDK License Error : Invalid Verification!</wrap> \\
+This is the Suprema license key you need in order to use server matching feature. \\
+Once you receive "UFLicense.lic" file, you need to activate them using "activate_lic.exe" file. \\
+Suprema ID sales team will give you further instruction on this. \\
+Suprema ID: sales_id@supremainc.com
-  * [[BS2_SetServerMatchingHandler]]: Configures the server matching handler.
+Once you activate the license, please copy this "UFLicense.lic" file into BioStar 2 device SDK folder. \\
+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]]: Registers the server matching handler.
   * [[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_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_SetUserPhraseHandler]]: [+ 2.7.0] Registers the server user phrase handler.
+  * [[BS2_ResponseUserPhrase]]: [+ 2.7.0] Transfers the user phrase to the device.
 ===== Callback Function ======
 <code cpp>
@@ Line 17: / Line 33: @@
 . //OnIdentifyUser// \\
 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>
+\\
+. //deviceId// \\
+Device ID  \\ \\
+. //seq// \\
+Packet sequence  \\ \\
+. //userID// \\
+User ID  \\ \\