BioStar 2 API Server is software that allows third-party apps to connect to and use the BioStar 2 API on a local network. It requires Windows Server 2008 R2 or later and at least 8GB of RAM. To install, download and run the setup file on a PC where BioStar 2 is already installed. The installation process registers the API Server with the BioStar 2 system. Once installed, access to the API documentation is available by visiting the API Server URL followed by /v2/docs.
BioStar 2 API Server is software that allows third-party apps to connect to and use the BioStar 2 API on a local network. It requires Windows Server 2008 R2 or later and at least 8GB of RAM. To install, download and run the setup file on a PC where BioStar 2 is already installed. The installation process registers the API Server with the BioStar 2 system. Once installed, access to the API documentation is available by visiting the API Server URL followed by /v2/docs.
BioStar 2 API Server is software that allows third-party apps to connect to and use the BioStar 2 API on a local network. It requires Windows Server 2008 R2 or later and at least 8GB of RAM. To install, download and run the setup file on a PC where BioStar 2 is already installed. The installation process registers the API Server with the BioStar 2 system. Once installed, access to the API documentation is available by visiting the API Server URL followed by /v2/docs.
BioStar 2 API Server is software that allows third-party apps to connect to and use the BioStar 2 API on a local network. It requires Windows Server 2008 R2 or later and at least 8GB of RAM. To install, download and run the setup file on a PC where BioStar 2 is already installed. The installation process registers the API Server with the BioStar 2 system. Once installed, access to the API documentation is available by visiting the API Server URL followed by /v2/docs.
Installing BioStar 2 API Server........................................................................4
Accessing BioStar 2 API Server ......................................................................6
Getting Started
Getting Started BioStar 2 API Server is a program to use BioStar 2 API on the local network. Before installation, please check the System Requirements.
System Requirements Item Medium Enterprise • Windows Server 2008 R2 Standard 64 • Windows Server 2008 R2 Standard bit or later 64 bit or later OS • Windows 7 Home Premium 64 bit or • Windows 7 Home Premium 64 bit or System requirement later later (Server) CPU 4 GHz Quad Core 4 GHz Quad Core RAM 8 GB 16 GB HDD 1 TB 2 TB
Limitation • With BioStar 2 API Server, only one third-party App can be connected. However, the number of available API calls is not limited. • With BioStar 2 API Server, push alarm function is not supported on BioStar 2 Mobile App. • When BioStar 2 API Server uses HTTPS, you cannot access the BioStar 2 Mobile App.
3 Installing BioStar 2 API Server
Installing BioStar 2 API Server
BioStar 2 supports a 64-bit operating system. Check the system type of your PC where the BioStar 2 API Server is to be installed and carry out its installation accordingly.
Note • Install BioStar 2 API Server on a PC which BioStar 2 is already installed. To install BioStar 2 API Server on a local network PC, Please contact the Suprema Technical Support Team (support@supremainc.com).
1 Double-click the downloaded setup program. (ex. 'BioStar 2 API Server(x64).x.x.x.xx.exe')
2 Select a language and click OK.
3 To continue the installation, select I accept the agreement and click Next.
4 Enter all fields correctly and click Next. We recommend that you use the default value.
4 Installing BioStar 2 API Server
5 Click Next after setting a path for BioStar 2 API Server to be installed.
6 If ready to install, click Install.
7 Click Finish after the file copy is complete.
5 Accessing BioStar 2 API Server
Accessing BioStar 2 API Server
1 Double click the BioStar 2 API Server(x64) icon on the desktop.
2 BioStar 2 API Server registration screen will appear. Enter all fields correctly and click Register.
• Enter the subdomain name in the API Server Name field.
• Click the drop-down menu to select a protocol type. • If installing on the same PC as BioStar 2, enter ‘127.0.0.1’ for BioStar 2 AC IP Address. • You can check the port of BioStar 2 on the Web Server Configuration of BioStar Setting.
• Enter the administrator account information in the Login ID and Password fields.
3 When the registration is completed, the following screen appears.
6 Accessing BioStar 2 API Server
4 To check the BioStar 2 API screen, click /v2/docs.
Note • Basic Setup of Quick Start is only for BioStar 2 Cloud user.
