|
|
|
API Configuration
For enhanced security, it is strongly recommended that HTTPS be used in preference to HTTP. This is because all HTTPS sessions are encrypted. Use HTTP only if the Http requests are not routed via the internet. To use HTTPS, you would require a SSL Certificate and SSL Key.
The API Service Configuration consists of a Settings tab and provision for up to 10 Configuration tabs.
Settings Tab
This tab defines the general settings required for the API Service.
Service Port: (For HTTP only) Specify the network port which is dedicated to this API service.
Use Https: Tick this box if you are using HTTPS.
Https Port: Specify the HTTPS port if using HTTPS.
Static File Directory: Specify the directory of the Static File Folder. This folder is where you store html pages which can be accessed by the API user.
Alternate DB Username: If the Firebird Database Username is not the default, then enter it here.
Alternate DB Password: If the Firebird Database Password is not the default, then enter it here.
Override Local IP Address: For HTTP: If there is more than one IP address for that server, this allows you to specify the specific IP address used for the API Service when connecting locally.
For HTTPS: Enter the Domain Name here. (The domain which has the SSL certificate issued by a Certification Authority.)
Override Remote IP Address: For HTTP: If there is more than one IP address for that server, this allows you to specify the specific IP address used for the API Service when connecting remotely.
For HTTPS: Enter the Domain Name here. (The domain which has the SSL certificate issued by a Certification Authority.)
Note: For HTTPS, the SSL certificate needs to be installed and configured using windows http.sys .
Config Tabs
There are ten configuration tabs (Config 0 to Config 9) allowing you to define up to 10 databases that can be accessed via the API Service.
Active: Tick this box if you want the Database named below to be accessible via the API service. This allows you to switch ON or OFF the API access to the database.
Allow Freeway Access: Tick this box if you want the Database named below to be accessible by the Freeway Mobility apps.
Note: The Ostendo API Service must be activated/re-started whenever the Mobility License Code is loaded (in Mobility Rules).
The Mobility App can connect to Ostendo either via wifi - Local Area Network (LOCAL) or via the internet/WAN (REMOTE). This preference is specified in the Configuration Values of the Freeway app. For REMOTE connection, you will need to get the IPv4 address of your Ostendo server and set up Port Forwarding on your router so that all calls to that API port will be forwarded to the Ostendo server correctly.
NOTE: For operating environments with very strict security where access to websites are tightly controlled, please ensure the following two sites are allowed:
This is required to allow Freeway to send API keys to the cloud and determine IP addresses stored for Freeway.
Database Filename: Specify the full path of the Ostendo database.
Click here for more detail on how to setup the Ostendo API Service
Buttons
API Service: This button allows you to Start, Stop, Install, and Uninstall the API Service.
OK: This will close the API Service Configuration screen.
Cancel: This will cancel all changes made.