BioStar 2 is a web-based, open, and integrated security platform that provides comprehensive access control, time & attendance management, visitor management, and video log maintenance.

There is a new approach for integrating BioStar 2 with third-party systems. Suprema is now offering the BioStar 2 API — a server-level RESTful API — with which you can communicate with a BioStar 2 server. The API allows you to retrieve data from the server, create users and interact with control properties such as access groups and time schedules.

This webinar is not a new technology/information, but there is a slit change, and we want to remind our customers of the new BioStar 2 Local API.


- Understanding the BioStar 2 API

- The BioStar 2 Local API vs. the new BioStar 2 Local API

- How to use the new BioStar 2 Local API

Recommended Level / Recommend Attendee  

Beginner & Intermediate Technical Sales of Suprema products,  Beginner & Intermediate Technical Engineers of Suprema products

Presentation file: 

Please click here or find the attached file.

Recorded video file: 


Peter Kweon, Technical Consulting Engineer I Suprema

Relevant Articles 

For more information about BioStar 2 API and its features, click here.   

[BioStar 2 API] How to use and start BioStar 2 New Local API

BioStar 2 New Local API Articles

How to use Swagger UI and Postman for BioStar 2 New Local API

Useful Files 

Swagger UI without BioStar 2 Installation

  • Please unzip the above file and run index_local.html to Chrome or Edge browser.
  • You cannot run [try out] without BioStar 2 Server connection.
  • From BioStar 2.8.14, you would be available to get the executable file. (C:\Program Files\BioStar 2(x64)\nginx\html\swagger)

C# Sample Codes

Q&A List  

1.  If I don't install BioStar 2 Server, could I get BioStar 2 new local API document?

You can get BioStar 2 new local API document from the below download link.

You can review all API explanations in the Swagger UI.

However, you cannot run [try out] without BioStar 2 Server connection.

2. Is BioStar 2 local API still maintained with the current BioStar 2?

It's maintain with the current BioStar 2, but there would be no new features.

3. How long will it take to expire one bs-session ID? and how often should we refresh the bs-session ID?

Default session timeout is 1 hour and you can configure it to Settings>Server>Session Timeout as follows.

4. Is it possible to make users who access to new API have read-only privilege?

You can make a custom-level account in BioStar 2 setting. and then, assign the "read" privilege to the operator level.

Please click the below article title for more details.

How to Configure a Custom Level

5. Should I have to install an additional setup if I installed BioStar 2?

You don't need to have an additional setup to use a new BioStar 2 local API. 

Once you install BioStar 2 server, it means that you can use BioStar 2 new local API.

6. Do you plan to add TA functionality to the current Local API?

From BioStar 2.8.13, we will release BioStar 2 TA API for only updating the report feature.

7. Can I use HTTPS with New Local API?

Default is HTTPS, and you can also use HTTP by BioStar 2 Server connection option.

8. Is there a functional difference between New local API and the previous local API?

The new local API has many more functions than the previous local API.

The difference is the parameter in the API and the API name.