Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
en:server_api [2017/03/21 11:31] 127.0.0.1 external edit |
en:server_api [2024/04/09 19:04] (current) alex [Server API] |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| 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> \\ | ||
| + | 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. \\ | ||
| + | Please reference the prior examples at the code level only. \\ \\ | ||
| + | Other technical supports including libraries for server matching can be provided by SupremaID sales team. \\ | ||
| + | <wrap hi>Suprema ID : sales_id@supremainc.com</wrap> \\ | ||
| + | </callout> | ||
| - | * [[BS2_SetServerMatchingHandler]]: Configures the server matching handler. | + | * [[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_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_SetBarcodeScanListener]]: [+2.8.2] Register the listener function that detects barcode input. | ||
| + | * [[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 17: | Line 32: | ||
| 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. \\ \\ | ||