Activating TestEngine License

Applies to TestEngine 1.26, last modified on September 22, 2022

To use TestEngine, you need to have a license. This topic explains how to activate a fixed license.

Requirements

  • To activate a fixed license online, you need a functioning Internet connection.

  • The firewalls and proxies in your network should allow access to the https://activation.smartbear.com and https://licenseusage.smartbear.io web sites through the 80 and 443 ports.

    If you use TestEngine behind the proxy, you need to do the following:

    1. Close TestEngine if it is running.

    2. Open the ReadyAPITestEngine.vmoptions file in any text editor (for example, Notepad or Vim). The file is located in the <TestEngine installation>/bin/ folder.

    3. Add the following lines:

      -Dhttp.proxySet=true
      -Dhttps.proxySet=true
      -Dhttp.proxyHost=<Proxy address>
      -Dhttp.proxyPort=<Proxy port>
      -Dhttps.proxyHost=<Proxy address>
      -Dhttps.proxyPort=<Proxy port>
    Docker container behind the proxy

    If your docker container runs behind the proxy, add the following arguments to the run command:

    -e JVM_OPT_HTTP_PROXYSET="-Dhttp.proxySet=true"
    -e JVM_OPT_HTTPS_PROXYSET="-Dhttps.proxySet=true"
    -e JVM_OPT_HTTP_PROXYHOST="-Dhttp.proxyHost=<Proxy address>"
    -e JVM_OPT_HTTP_PROXYPORT="-Dhttp.proxyPort=<Proxy port>"
    -e JVM_OPT_HTTPS_PROXYHOST="-Dhttps.proxyHost=<Proxy address>"
    -e JVM_OPT_HTTPS_PROXYPORT="-Dhttps.proxyPort=<Proxy port>"

Using Web UI

  • Install TestEngine and start it.

  • Open the TestEngine web interface and log in as an administrator:

    http://<testengine-host>:<port>/

    For example, if TestEngine is installed on your local machine, and you run it on the default port, use the following link:

  • TestEngine will open the Manage License page. Click Add License:

    Activating license in Web UI: Server panel

    Click the image to enlarge it.

  • In the subsequent dialog, select License from File, click Browse, and specify the TestEngine license file (.zip or .key file):

    Activating license in Web UI: Browse for license

    Click the image to enlarge it.

  • Fill in the form fields and click Install:

    Activating license in Web UI: Activate license

    Click the image to enlarge it.

  • The License tab will show information on the license:

    Activating license in Web UI: License info

    Click the image to enlarge it.

Using API

Use the following operation:

POST  http://<testengine-host>:8080/api/v1/license

Authentication

The request must be authenticated by a TestEngine administrator.

Content type

multipart/form-data

Body

The body must include two parts:

  • file: the license file in the .zip or .key format.
  • activationInfo: the license activation info in the JSON format. The JSON string can include the following properties:
    • firstName (required)
    • lastName (required)
    • email (required)
    • company
    • address
    • city
    • zipCode
    • state
    • country
    • phone

Authentication

The request must be authenticated by a TestEngine administrator.

Use the following command line:

curl -u "admin:password" -F file=@"C:\Work\TestEngine\license.zip" -F activationInfo={\"firstName\":\"Jeanne\",\"lastName\":\"Desthieux\",\"email\":\"jeanne.desthieux@mycompany.com\"};type=application/json "http://localhost:8080/api/v1/license"

In this example:

-u admin:password

Authenticates the request by using the admin’s credentials.

-F file=@"C:\Work\TestEngine\license.zip"

The license file.

-F activationInfo={\"firstName\":\"Jeanne\",\"lastName\":\"Desthieux\",\"email\":\"jeanne.desthieux@mycompany.com\"};type=application/json

The activation info in the JSON format.

"http://localhost:8080/api/v1/license"

The endpoint of the request.
  1. Create a project by using the TestEngine API definition. See Creating Project From OpenAPI/Swagger Definition to learn how to do that.

    Tip: You can also create the needed request from scratch.
  2. Select the POST request to the /api/v1/license resource:

    Activate the license: Select a request

    Click the image to enlarge it.

  3. Set the Media type to multipart/form-data:

    Activate the license: Set the media type

    Click the image to enlarge it.

  4. Open the Attachment panel and click Add Attachment:

    Activate the license: Add the license as an attachment

    Click the image to enlarge it.

  5. Specify the license file.

  6. Set the ContentID of the attachment to file:

    Activate the license: Set ContentID

    Click the image to enlarge it.

  7. Create a .json file with the activation info and add it as an attachment as well:

    Activate the license: Add the activation info as an attachment

    Click the image to enlarge it.

  8. Change the Content type of the .json attachment to application/json, and its ContentID to activationInfo:

    Activate the license: Configure the attachment

    Click the image to enlarge it.

  9. Open the Auth panel.

  10. Select the Basic (Built-in) authorization type.

    Tip: If you use the same credentials in several request, use authorization profiles.
  11. Specify the user credentials and select the Authenticate pre-emptively option:

    Activate the license: Add authorization

    Click the image to enlarge it.

  12. Send the request:

    Activate the license: Send the request

    Click the image to enlarge it.

  13. If the operation was successful, you will receive license information in the response:

    Activate the license: View the licensing info

See Also

Change Your Password
Deactivating TestEngine License
Reactivating TestEngine License
Analyzing License Usage

Highlight search results