Web API URL

The Web API URL (also called Web API site URL) indicates the URL of the Web API application executable file (ServerAPIs.exe), and it is the root URL for all PowerServer Web APIs (such as /api/ServerApiCreateSession, /api/ServerApi/ConnectAndCreateTransaction etc.)

When PowerServer Web APIs is deployed to the web server, the site URL or the site URL + sub-folder name will become the Web API URL:

  • For Kestrel, the server site URL = the Web API URL, such as "http://172.16.100.2:5000/".

  • For IIS, if you place the compiled Web API files (including ServerAPIs.exe, web.config, app assembly files, dependencies etc.) directly in the IIS Web root, the server site URL = the Web API URL, such as "http://172.16.100.2:83/".

  • For IIS, if you place the compiled Web API files in a sub-folder under the IIS Web root, and then convert the sub-folder to sub-application in IIS, then the server site URL + sub-folder name = the Web API URL, such as "http://172.16.100.2:83/googlecharts_cloud_API/".

  • For IIS, if you place the compiled Web API files in a sub-folder under the IIS Web root, and the web.config file in the web root points to ServerAPIs.exe in this sub-folder (such as ".\salesdemo_cloud_API\ServerAPIs.exe"), then the server site URL = the Web API URL, such as "http://172.16.100.2:83/".

The client app must call the PowerServer Web APIs to handle the database connections, data processing, PowerServer license activation etc., therefore, each client app must know the root URL of the corresponding PowerServer Web APIs.

For how to configure the Web API URL for a client app, refer to Configure the Web API URL.