Notice
This page is related to the new SmartBear ID-based licenses that we've introduced in ReadyAPI 3.8.1.
In this version, we included support for SmartBear-hosted ID-based (online) licenses. Furthermore, from version 3.40.0, we added support for on-premise hosted and offline ID-based licenses.
Running ReadyAPI on a headless machine means that it works from the command line. The same happens when you run ReadyAPI and its test runners from a CI/CD build.
To specify the SmartBear account to be used for the run, you add certain parameters to the command line. See below for details.
Important
If you use SSO to log in to the SmartBear account, you must use the access key. If you do not know whether you use SSO or not, ask your license manager for assistance.
The computer where you are going to run tests must have access to the SmartBear License Servers. The proxies and firewalls running in our network should allow connection to them:
https://manage.smartbear.com:443https://api.slm.manage.smartbear.com:443https://login.slm.manage.smartbear.com:443https://server.manage.smartbear.com:443https://server.slm.manage.smartbear.com:443https://profile.id.smartbear.com:443https://profile-api.id.smartbear.com:443https://auth.id.smartbear.com:443
This access is needed both at the product start and during the product runtime. The addresses are for API servers and don’t have a user interface visible in browsers. When products call these hosts, they add some specific paths or URLs to the addresses.
Note
We encrypt all data at rest and over the wire.
Important
Please note, as outlined here and in our Terms of Use:
Floating licenses are required for scenarios including multiple authorized users, service accounts, and machine combinations including virtual machines and containerized environments. Floating licenses are required for any headless use case with virtual machines and docker.
It is a more secure way, and our recommendation is to specify the SmartBear account for the run by using an access key generated for your account.
You get the key in the SmartBear Licensing Portal:
 |
For complete information, see the Get Access Key in the Licensing Portal documentation.
Activate with Access Key – Get the access key from the SmartBear Licensing Portal and use it as a command-line parameter, either as -accessKey or -K key.
Sample Command
testrunner.bat "c:\my tests\my-proj.xml" -accessKey "9a######-####-####-####-##########97"
Important
Make sure to enclose the access key in quotes.
Note
SmartBear License Management's license authentication and request flows were revised in November 2023. Authentication using the username and password is no longer supported for test execution via TestRunners, Jenkins or Azure plugins, and SmartBear-hosted licenses. Username and password are limited to on-prem-hosted licenses only. Access Key is the required option for authentication if using SmartBear-hosted licenses headlessly.