TestComplete REST API

TestComplete provides several APIs:

• TestComplete REST API - Enables you to access the test engine from third-party tools. It is described below.

• TestComplete Service API - Enables you to control projects and test runs from third-party tools, for instance, from continuous integration (CI) systems. To learn more, please see TestComplete Service REST API.

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.

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. You can enable the plugin:

• In the File > Install Extensions dialog in TestComplete.

• By using the StartRestServer command of the SessionCreator utility.

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/