Get Started with Web API Service

The GCS Web API Service supports the SSL connection between the Galaxy DoorPoint or PersonPoint Mobile Apps and the System Galaxy database.

 

WHAT'S IN THIS CHAPTER

The following topics are found in this section...

1. Deployment Considerations: Networking & Requirements
2. Set up the Web API Service
3. Start the Web API Service
4. Change the Port Number for the Web API Service (recommended)
5. Test the Web API Service
6. Obtain & Import a CSR & Certificate

Jump to Get Started with - DoorPoint or PersonPoint Chapters for information about the mobile apps.

 

 

DEPLOYMENT CONSIDERATIONS

1. The GCS Web API Service is installed as manual start-up on the main System Galaxy Communication Server (during Part-3A of he software installer) .
2. The Web API Service must be configured to run as "start automatically" after you have finished Part-3A of the SG software install.
3. The Mobile Apps require you to use SSL (HTTPS) with a valid Certificate using a private key.
4. The default port numbers can be changed as needed.

 

NETWORK AND SECURITY

Take appropriate steps to protect your Access Control System. Do not leave your system, services, or mobile apps exposed.

1. You should obtain in a CSR / SSL Certificate to encrypt your mobile communications. This is used in addition to the typical network security (i.e. firewalls, passwords, etc.) to protect the mobile data communications.

2. Maintain the latest Windows updates on the main SG Communication Server, Database server, and client PCs.

3. Galaxy only supports secure/encrypted connections. HTTPS secure socket connections with an SSL Certificate for your Mobile Apps is required in the live production environment.

   • Private Access: Galaxy Apps to connect to a private wireless router when the smartphone is within range.

   • Public Access: Galaxy Apps to connect to a public network router using a Public Cellular Provider.

.

SYSTEM REQUIREMENTS

1. Galaxy Mobile Apps are compatible with SG 10.5.1(minimum SG 10.4.9 (or higher)).
2. You need 3-4 MB drive space on the mobile device to install the apps.
3. System Galaxy Web API Service, all core services and the database must be installed and running to operate the Mobile Apps.
4. The GCS Web API Service should reside on the main System Galaxy Communication Server.
5. The Mobile Communications must be protected by an SSL Certificate with privacy key in tact.
   1. The SSL Certificate must reside on the same server with the GCS Web API Service.
   2. Galaxy only supports secure/encrypted connections. HTTPS secure socket connections with an SSL Certificate for your Mobile Apps is required in the live production environment. Self-signed certificates are not supported.
6. GCS Web API Service must use a unique port number. It cannot share port 80 or 443 with IIS or other apps/programs.

» 8000 is default HTTP port (configurable) – useful for testing environment only

» 8443 is default HTTPS port (configurable) – for live/production environment

6. GCS Web API Service must be configured with a valid SG login and password that exists in System Galaxy. These SG credentials (username and password) must be active/valid in System Galaxy and must have the appropriate privileges that support the functions of service. The SG credentials must be configured into the service’s ‘exe.config’ file. This file can be encrypted using the same method and tools you use to encrypt the SG Web Module – See the web module guide for details. This does not affect the main GCS Communication, Event, Client Gateway and DB writer services.
7. The users of the Mobile Apps must use a valid SG Login that has the appropriate privileges to support the functions of the apps.

 

 

 

SEE ALSO