Applies to TestComplete 14.0, last modified on January 24, 2019

TestComplete provides a REST API that enables you to access the test engine from third-party tools.

You can use the API to control TestComplete options, to access applications running on your computer (as well as their internal objects) and to simulate user actions over them.

Generally, the REST API is used by TestLeft to send test instructions from your TestLeft tests to the test engine.

Requirements

The REST API plugin must be installed and enabled in TestComplete. The plugin is installed automatically when you install TestComplete.

By default, the plugin is disabled. Enable the plugin in the File | Install Extensions dialog in TestComplete.

Web Interface

The REST API has a web interface where you can see the available API operations and parameters, make API calls and view the returned data.

You can access the API web interface at the following URL:

http://{host-name}:{port}/

where —

  • host-name - is the network name or IP address of the computer where TestComplete is running,

  • port - is the port number the TestComplete RESTful service is using. The default port is 2377 . To specify the port the API should use, use the RestServerPort command-line parameter.

To access the web interface on your local computer by using the default port, use the following URL:

http://localhost:2377/

Highlight search results