Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision Next revision Both sides next revision | ||
|
en:types_of_biostar_2_api [2017/06/23 16:36] 127.0.0.1 external edit |
en:types_of_biostar_2_api [2019/05/29 15:30] yjjung [BioStar 2 Local API] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== Types of BioStar 2 API ===== | + | ===== Structure of BioStar 2 Local API ===== |
| ---- | ---- | ||
| - | There are two types of BioStar 2 API: BioStar 2 Cloud API and BioStar 2 Local API. \\ | + | 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. \\ \\ |
| - | 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. \\ \\ | + | |
| - | {{ :en:api_1.png?nolink&500 |}} \\ \\ \\ | ||
| - | ==== BioStar 2 Cloud API ==== | + | ==== BioStar 2 API Server(Local 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). | + | BioStar 2 API Server(Local API) does not utilize the Cloud Server. Instead of usage of Cloud Server, you must install BioStar 2 Local API server separately on the local site. In this case, Ngrok is not needed since BioStar 2 Local API server is located in the same place with BioStar 2 server. |
| - | + | ||
| - | {{ :en:api_2.png?nolink&800 |}} \\ | + | |
| - | + | ||
| - | <callout type="info" icon="true"> | + | |
| - | * **Pros:** | + | |
| - | - Available to call BioStar API by using subdomain name without public IP \\ \\ | + | |
| - | + | ||
| - | * **Cons:** | + | |
| - | - Limit to processing speed \\ | + | |
| - | </callout> | + | |
| - | \\ \\ \\ | + | |
| - | + | ||
| - | ==== 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. | + | |
| {{ :en:api_3.png?nolink&800 |}} \\ | {{ :en:api_3.png?nolink&800 |}} \\ | ||
| Line 33: | Line 16: | ||
| * **Cons:** | * **Cons:** | ||
| - When approaching from outside, either public IP or signing up DDNS service is required \\ | - When approaching from outside, either public IP or signing up DDNS service is required \\ | ||
| - | - Installation of **BioStar 2 API Server** is required \\ | + | - Installation of **BioStar 2 API Server** is required \\ \\ |
| + | |||
| + | * **Reference File:** | ||
| + | [[https://www.supremainc.com/en/support/development-tools_biostar-2-api.asp|BioStar 2 API Server Download Page]] \\ | ||
| + | |||
| + | |||
| </callout> | </callout> | ||
| - | \\ \\ \\ | + | \\ \\ \\ |