API Configuration

When installing or upgrading QA Inspector, the application runs an automatic check to determine whether the API communication must be enabled by default:

  • If QA Inspector detects previous connections to external systems or applications via API, the API communication is enabled by default. This is the case of QA Inspector upgrades in which the database of the previous version is kept through the upgrade.

  • If QA Inspector does not detect previous connections to external systems or applications via API, the API communication is disabled by default. This is the case of QA Inspector first installations, or of QA Inspector upgrades in which the database of the previous version has been deleted.

To configure the API communication, do the following:

  1. In the Home page, tap Configuration > External systems > API configuration.

  2. Select the Enabled checkbox if not already selected.

  3. In the API port field, type the port number to use for the communication with external systems.

    • API port maximum value: 65535; default value: 60005

  4. Select the  Secure Connection (TLS) checkbox to enable encryption.

  5. Select the  Mutual TLS (mTLS) checkbox to enable mutual authentication and encryption.

    • You can enable mTLS only if TLS is enabled.

  6. Tap Save.