Book Creator
 Add this page to your book
Book Creator
 Remove this page from your book  

 Manage book (0 page(s))
 Help

This is an old revision of the document!

Server API

API that can enable server matching or controls the device from the BioStar application.

Warning


BioMini&Image SDK License Error : Invalid Verification!
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

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.

  • 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_IdentifyUser: Transfers user information mapped to the fingerprint authentication results to the device.
  • BS2_VerifyUserEx: [+ 2.4.0] Transfers user information mapped to the card or user ID authentication results to the device.
  • 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] Configures the server user phrase handler.
  • BS2_ResponseUserPhrase:​ [+ 2.7.0] Transfers the user phrase to the device.

Callback Function

typedef void (*OnVerifyUser)(uint32_t deviceId, uint16_t seq, uint8_t isCard, uint8_t cardType, const uint8_t* data, uint32_t dataLen);
typedef void (*OnIdentifyUser)(uint32_t deviceId, uint16_t seq, uint8_t format, const uint8_t* templateData, uint32_t templateSize);

1. OnVerifyUser
Callback function that is called when the BioStar application needs to distinguish whether the card or user ID matches.

2. OnIdentifyUser
Callback function that is called when the BioStar application needs to distinguish whether the fingerprint matches.


OnUserPhrase

개인 메시지를 서버에 요청하는 콜백 함수입니다. 

typedef void (*OnUserPhrase)(uint32_t deviceId, uint16_t seq, const char* userID);


1. deviceId
장치 식별자입니다.

2. seq
패킷 일련번호입니다.

3. userID
사용자 ID 입니다.