When the Web API is installed in a development environment, you can open the Web API help page for technical information about the API endpoints and other programming considerations.
Before you begin
- Install the Web API software in your development environment.
- Enable access to the web documentation during Install the Web API software, or by modifying the Web API configuration.
What you should know
Procedure
To open the Web API developer documentation:
Open the following URL in a web browser:
https://<network_host>:<api_port>
Where:
- <network_host> is the address of the computer hosting the Web API.
- <api_port> is the network port assigned to the Web API. By default, port 9550 is used.
The web document opens.