This is an old revision of the document!



There are two types of BioStar 2 API: BioStar 2 Cloud API and BioStar 2 Local API.
Since BioStar 2 Cloud Server is located in Amazon Japan, you do not need to install any application to use BioStar 2 Cloud API except for setting cloud use.
On the other hand, in case of BioStar 2 Local API, you should install additional application named BioStar 2 API Server on the local PC where BioStar 2 server has been already installed. In other words, BioStar 2 Local API can be used without cloud server.




BioStar 2 Cloud API

This diagram is about BioStar 2 Cloud API. An important point is that you access BioStar server by calling BioStar 2 API via Cloud Server. Furthermore, Ngrok is the secure tunnels that allows the external request(e.g. User Application) to access the local site(e.g. BioStar Server).


  • Pros:
    1. Available to call BioStar API by using subdomain name without public IP

  • Cons:
    1. Limit to processing speed




BioStar 2 Local API

BioStar 2 Local API does not utilize the Cloud Server. Instead of usage of Cloud Server, you must install BioStar 2 API server separately on the local site. In this case, Ngrok is not needed since BioStar 2 API server is located in the same place with BioStar 2 server.


  • Pros:
    1. No limit to processing speed

  • Cons:
    1. When approaching from outside, either public IP or signing up DDNS service is required
    2. Installation of BioStar 2 API Server is required