Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:possible_integration_options_in_biostar_2 [2018/02/26 17:08]
kate [BioStar API]
en:possible_integration_options_in_biostar_2 [2021/08/19 08:40] (current)
peterk [BioStar2 Local API]
Line 3: Line 3:
 ===== Possible integration options ===== ===== Possible integration options =====
 ---- ----
-There are three possible integration approaches in integrating Suprema readers to a 3rd party system: using Protocol, BioStar Device SDK and BioStar API(with BioStar2 Local API Server).+There are three possible integration approaches in integrating Suprema readers to a 3rd party system: using Protocol, BioStar Device SDK and BioStar API.
  
   * BioStar Device SDK: Developing own application using the APIs provided by Suprema. It’s not possible to communicate with a server (e.g. BioStar Server). Developers need to implement the functionality to manage and control devices. BioStar Device SDK is in the form of Windows DLL, so the application you’re developing should be a Windows based application.   * BioStar Device SDK: Developing own application using the APIs provided by Suprema. It’s not possible to communicate with a server (e.g. BioStar Server). Developers need to implement the functionality to manage and control devices. BioStar Device SDK is in the form of Windows DLL, so the application you’re developing should be a Windows based application.
-  * BioStar Local API (BioStar2 Local API Server): Developing own application using the RESTful APIs that the BioStar 2 Local API Server ​provides. If you use BioStar Local API, you’re communicating with your local BioStar 2 server ​through the BioStar 2 Local API Server. [[https://​www.supremainc.com/​sites/​default/​files/​biostar2_api_server_v2.5.0.53_0.zip|BioStar2 Local API Server v2.5 Download]]+  * BioStar Local API: Developing own application using the RESTful APIs that the BioStar 2 provides. If you use BioStar Local API, you’re communicating with your local BioStar 2 server. ​
   * Database Linking: Developing own application that directly accesses databases of the two systems that you want to integrate. In this approach, you don’t have to use BioStar-specific APIs or libraries. Instead, the application synchronizes the two systems at the database level.   * Database Linking: Developing own application that directly accesses databases of the two systems that you want to integrate. In this approach, you don’t have to use BioStar-specific APIs or libraries. Instead, the application synchronizes the two systems at the database level.
  
Line 29: Line 29:
 If your T&A software offers server-level API, the SDK-based application will call the APIs instead of accessing the database directly. If your T&A software offers server-level API, the SDK-based application will call the APIs instead of accessing the database directly.
  
-==== BioStar ​API ====+==== BioStar2 Local API ====
 So far we have looked at BioStar Device SDK. With the BioStar 1 system, we only had BioStar Device SDK, which means that it was not possible to either request data from a BioStar 1 server or control devices connected to the server by sending commands to the server. You always had to deal with the devices directly. Dealing with the devices directly is not an easy task because you have to implement user and device management on your own. If you need to use advanced access control rules like access groups, things get more complicated. So far we have looked at BioStar Device SDK. With the BioStar 1 system, we only had BioStar Device SDK, which means that it was not possible to either request data from a BioStar 1 server or control devices connected to the server by sending commands to the server. You always had to deal with the devices directly. Dealing with the devices directly is not an easy task because you have to implement user and device management on your own. If you need to use advanced access control rules like access groups, things get more complicated.
  
-To ease these difficulties,​ we are now offering BioStar2 Local API and BioStar2 Local API Server, server-level RESTful API, with which you can communicate with BioStar 2 server. Therefore, you can get data from the server, create users and access control properties like access groups and time schedules. You can also control devices through BioStar2 Local API & BioStar2 Local API Server. We are not going to take a look at what RESTful API is about, because it’s out of scope of this article. You can find detailed information on RESTful API from Wikipedia (https://​en.wikipedia.org/​wiki/​Representational_state_transfer).+To ease these difficulties,​ we are now offering BioStar2 Local API, server-level RESTful API, with which you can communicate with BioStar 2 server. Therefore, you can get data from the server, create users and access control properties like access groups and time schedules. You can also control devices through BioStar2 Local API. We are not going to take a look at what RESTful API is about, because it’s out of scope of this article. You can find detailed information on RESTful API from Wikipedia (https://​en.wikipedia.org/​wiki/​Representational_state_transfer).
  
 With the server-level API, you can focus your own logic leaving all the complicated tasks like user/​device/​access control management to BioStar 2 server. This will greatly shorten the development time. With the server-level API, you can focus your own logic leaving all the complicated tasks like user/​device/​access control management to BioStar 2 server. This will greatly shorten the development time.
 +
 +There'​s no need for any additional installation for BioStar 2 Local API. Once BioStar 2 Server is installed, it is ready to be used by the user without any additional installations for Local API Server. Moreover, it doesn'​t require any other additional license activation and it is free of charge to all users.
  
 {{:​en:​003.png?​nolink&​800|}} \\ {{:​en:​003.png?​nolink&​800|}} \\
Line 49: Line 51:
  
  
-==== BioStar Device SDK vs BioStar ​API ==== +==== BioStar Device SDK vs BioStar2 Local API ==== 
-Now that we have taken a closer look at what BioStar Device SDK and BioStar ​API are about, it’s time to discuss advantages and disadvantages of each option. ​+Now that we have taken a closer look at what BioStar Device SDK and BioStar2 Local API are about, it’s time to discuss advantages and disadvantages of each option. ​
  
 {{:​en:​table-1.png?​nolink&​600|}} \\ {{:​en:​table-1.png?​nolink&​600|}} \\
  
-  * Simple Installation:​ With BioStar Device SDK, you can implement the features that you need for your project, so you can create a simple and lightweight Suprema reader and user management tool. If you use BioStar API, you must install BioStar 2 Server and set up BioStar Cloud.+  * Simple Installation:​ With BioStar Device SDK, you can implement the features that you need for your project, so you can create a simple and lightweight Suprema reader and user management tool. {{ :​en:​biostar_2_api_server_2.5.0_ig_en_v1.0.pdf }}
   * Ease of Development:​ As I mentioned above, developing applications with BioStar API is a lot easier because you can use BioStar 2 as an access control system and all you need to do is developing a bridge between BioStar 2 and a 3rd party system.   * Ease of Development:​ As I mentioned above, developing applications with BioStar API is a lot easier because you can use BioStar 2 as an access control system and all you need to do is developing a bridge between BioStar 2 and a 3rd party system.
   * Multi Operating System Support: Although BioStar 2 Server supports Windows only, you can create applications on any operating system as long as the operating system supports HTTP communications. For example, you can create an Android mobile application that communicates with BioStar server installed on a Windows PC. On the other hand, BioStar Device SDK is provided in the form of Windows DLL and Linux library, which means that you cannot create a mobile application with BioStar Device SDK.   * Multi Operating System Support: Although BioStar 2 Server supports Windows only, you can create applications on any operating system as long as the operating system supports HTTP communications. For example, you can create an Android mobile application that communicates with BioStar server installed on a Windows PC. On the other hand, BioStar Device SDK is provided in the form of Windows DLL and Linux library, which means that you cannot create a mobile application with BioStar Device SDK.
Line 61: Line 63:
  
  
 +==== New Possible Integration Options ====
  
 + ​Currently,​ we have another integration option for your system via SVP Android SDK. Please check our new integration option from the link below.
 +  * [[http://​kb.supremainc.com/​knowledge/​doku.php?​id=en:​possible_integration_options_2_in_biostar_2|Possible Integration Options 2]]