Activate and Use ReadyAPI

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.

Since ReadyAPI 3.8.1, we have started offering the new (SmartBear ID-based) license type. To use ReadyAPI, sign in with your SmartBear account (or SmartBear ID). This method is simpler and more convenient than downloading and installing license files. The following section explains how to apply for and use SmartBear ID-based licenses.

How to create a SmartBear account

When you request the product on our website, we create an account for you. You get an email notification with a link to set your password. Follow that link to complete your account setup.

Note

We created an account for the email address you entered in the trial request form. If an account already exists for this email, we use the existing account instead of creating a new one.

Use your account to sign in to the product. See the instructions below.

Requirements

The new licenses are controlled by SmartBear online License Servers. The computer where you are going to run ReadyAPI must have access to these servers. The proxies and firewalls running in your network should allow a permanent connection to them:

  • https://manage.smartbear.com:443

  • https://api.slm.manage.smartbear.com:443

  • https://login.slm.manage.smartbear.com:443

  • https://server.manage.smartbear.com:443

  • https://server.slm.manage.smartbear.com:443

  • https://profile.id.smartbear.com:443

  • https://profile-api.id.smartbear.com:443

  • https://auth.id.smartbear.com:443

Copy the files from the <WebLogic>\wlserver\server\lib directory.

Note

We encrypt all data at rest and over the wire.

Trial license

Option 1 — Request a trial from the website

In this case, the ReadyAPI trial doesn't require any special activation. You can download, install, and run it. The trial installation has all the data needed for the run. It uses the SmartBear account that was created for you when you requested the trial.

Important

You receive an email for your SmartBear account. Follow the link in the email to set a password and complete your account setup.

If ReadyAPI cannot activate the trial (for example, if you are working in a private network without access to SmartBear license servers), ReadyAPI prompts you to use an offline or on-premise floating trial license. For instructions, see Activate Trial in Private Networks.

Option 2 — Request a trial from the application

If you already have a commercial license for one of the ReadyAPI modules (Test, Performance, or Virtualization), you can request a trial for another module:

  1. From the main menu of ReadyAPI, select Help, and then License Manager. The License Manager dialog opens.

  2. In the dialog, select the ReadyAPI module that you want to get a trial for.

  3. Click Start Pro Trial to begin the trial process.

  4. Follow the on-screen instructions to complete the setup.

Commercial licenses

SmartBear ID-based licenses can be Fixed User or Floating (see more on this in the SmartBear License Management documentation). The activation steps listed below work for both license types.

1. Admin steps — Assign the licenses to end-users

When you purchase a license, you designate a license administrator on your side. This person manages license use and assigns licenses to your teammates.

The license administrator works on the SmartBear Licensing Portal: https://manage.smartbear.com.

  • To assign licenses, follow the instructions in the SmartBear License Management documentation.

  • If your teammates don’t have SmartBear accounts, the license administrator can invite them to the portal. Use corporate email addresses for invitations, not personal ones.

  • The license administrator can assign licenses to themselves if necessary.

2. User steps

1. Complete account creation

If your license administrator assigns a license to you and you don't have a SmartBear account, the Licensing Portal sends an invitation email. This email contains a link to the portal. Follow the link and set a password for your SmartBear account to complete account creation. After that, you can download the product installer from the portal.

If you already have a SmartBear account, the portal does not send an invitation. Instead, you receive a notification about the assigned license.

2. Install ReadyAPI

  1. Download the ReadyAPI installer from the Licensing Portal: https://manage.smartbear.com.

  2. Run the installer and follow the instructions in the installation wizard.

3. Activate ReadyAPI

Note

Make sure your computer has access to the SmartBear License Servers mentioned in the Requirements.

Switching Between Accounts

When ReadyAPI opens a browser, it redirects you to the login page. If you're already logged in, you cannot switch accounts directly. To log in with a different account, you must first manually sign out of your browser.

Logging in is supported by SmartBear ID/SmartBear License Management. You can check which account is currently logged in at http://manage.smartbear.com/.

  1. Start ReadyAPI.

  2. From the main menu, select Help, and then License Manager.

  3. The License Manager dialog opens. Click Install license.

    RAPI_Screenshot_License_Activation_Install_License.png
  4. Select Login with SmartBear ID and click Log in:

    Screenshot of ReadyAPI showing the Install License dialog with activation options, highlighting the Login with SmartBear ID option that requires SmartBear ID or SwaggerHub credentials.

    Tip

    To configure a proxy, click configure-new.png.

    In the subsequent dialogs, enter your account’s email and password.

    Entering your credentials
  5. ReadyAPI now includes the option for basic authentication during SmartBear ID sign-in. This new feature will prompt a pop-up if your browser requires a username and password for basic authentication login.

    basic-authentication.png
  6. The License Manager dialog displays the ReadyAPI license available to you (if you have several of them, it will show you all available ReadyAPI-related licenses). Click Finish to consume them:

    Screenshot of ReadyAPI showing the Install License dialog after logging in with a SmartBear ID, displaying available licenses for ReadyAPI Test, ReadyAPI Performance, and ReadyAPI Virtualization.

    That’s all. You can use your ReadyAPI now.

Note

In ReadyAPI 3.42, we added a License Status update for ReadyAPI Performance License holders to show the maximum number of Virtual Users supported in your license.

Screenshot of ReadyAPI showing an active Performance subscription license with floating type, license number, expiration date, and maximum VUs set to 1001.

Tip

ReadyAPI remembers your credentials, so you don’t need to enter them every time you start the product.

Activate licenses on headless machines and automated runs

You can run both trial and commercial ReadyAPI licenses on headless machines and use these licenses in automated runs. To do this, copy an API key for your license from the SmartBear Licensing Portal and specify it in the ReadyAPI command line. For complete information, see Activate ReadyAPI on Headless Machines and in CI/CD build runs.

Note

As outlined in About ReadyAPI Licenses 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 also required for any headless use case with virtual machines and Docker.

Helpful links

go.gifAbout SmartBear-ID Based licenses

go.gifSmartBear Licensing Portal for UsersLicense Management for License Users

go.gifActivate Trial in Private Networks

go.gifFree a License Seat

See Also

SmartBear ID-based Licenses

Publication date: