A new API has been released with BioStar v2.7.10; it is also integrated by default in all later BioStar 2 versions.
One main difference from the old API is that the new API does not require a separate API server installation.
To use the new API, just install or upgrade to BioStar 2.7.10.
* Please note that the old Local API server(v2.6.3) is compatible with BioStar 2.7.10 *
Another key difference is that the new API supports all of BioStar 2's AC features, whereas the old API supported only part of BioStar 2's AC features.
If you'd like to view the revision notes on the BioStar 2 AC API, please refer to the following link: BioStar 2 API - Revision Notes.
It includes revision notes from v2.9.6.
If you are curious about a specific API's changes from versions before 2.9.6, please contact Suprema technical support.
We have a Postman documentation page that lists all of our AC APIs and provides details on each API.
Please check out the link if you are looking for APIs or details regarding specific APIs.
API Postman Documentation: https://bs2api.biostar2.com/
If you cannot find answers to your API questions from the above document, we recommend looking through our articles that can be found in the following links:
https://support.supremainc.com/en/support/solutions/folders/24000012785
https://support.supremainc.com/en/support/solutions/folders/24000012938
These articles contain a lot more detailed information regarding our APIs, answers to frequently asked questions/issues.
Now let's take a look at how to get started with BioStar 2 API.
In order to use any of the new BioStar 2 APIs, you need to first call the login API in order to authenticate.
After successfully calling the login API, save the session id that can be obtained from the response header to authorize and use any of the other BioStar 2 APIs. How to save 'session-id' for authorization in Postman :
a. Login using POST /api/login API with login credentials as parameters. Then click Send.
b. Find the 'session-id' from the response header.
c. When you are trying to call other APIs, please add this value in the header of request with key "bs-session-id".
* If you have an issue with 'session-id', please refer to the article below.
[BioStar 2 API] LOGIN REQUIRED error - Session is expired