API & References

You can check the details of the API.

📄️Return Code

The meaning of the return codes is shown below. To search your return code, press Ctrl+F.

🗃️SDK API

The followings are a set of APIs that initialize device management information and that are used for dynamic memory control and PIN code generation.

As API that configures the SSL communication, there are communication interfaces include LAN, USB, and RS485. To get real-time device connectivity and search results, please register the callback function via the BS2SetDeviceEventListener function.

🗃️Device API

API that controls the device information or upgrades the firmware.

🗃️Log Management API

API that controls the device log.

🗃️Access Control API

API for access control, which can manage access authority by individual, group, time schedules.

🗃️Door Control API

API that configures whether the device is set as entrance/exit of the door, how the device will control the door, and the APB settings.

🗃️Wiegand API

API that composes the Wiegand card readers and configures the Wiegand input/output.

🗃️Server API

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

🗃️SSL API

API that configures the SSL communication

🗃️User Management API

API that provides functions to enroll and delete users.

🗃️Configuration API

The following APIs are used to read and write system configuration information.

🗃️Smartcard API

API that provides a function that reads and writes card data.

🗃️QR Code API

API that provides functions to read and write QR code data.

🗃️Fingerprint API

API that provides functions to scan, extract, and compare fingerprint template data.

🗃️Face API

This API allows to scan/verify the face template.

🗃️Blacklist API

API that adds a card to the blacklist when a card is lost or to limit access.

🗃️Slave Control API

API that connects the master and slave device by using the RS-485 network. The v2 devices will now work as a dummy reader when set as a slave device. It will not store any kind of information for user and all will be stored inside the master device. The slave device will send the information scanned, and the matching and access rule check will be done from the master device. The slave device will only receive the result.