Help Center/ CodeArts TestPlan/ User Guide/ Configuring a Test Case/ Creating an Automated API Test Case/ Adding an API Test Script by Using a Custom URL Request/ Setting Authentication in an API Automation Test Case Script
Updated on 2026-08-11 GMT+08:00
View PDF
Share

Setting Authentication in an API Automation Test Case Script

To ensure only authorized users or clients access the target API, use authentication to verify identity and permissions before granting access. Key functions include:

  • Identity verification: Verifies credentials (such as a username and password) to ensure requests originate from an authorized user.
  • Permission control: Checks whether a user has the permission to access specific resources or perform specific operations.
  • API security: Prevents unauthorized access and protects sensitive data.

Authentication Methods

Select one of the following built-in authentication methods in API automation test case scripts, and configure verification information based on API requirements.

  • No Auth: No authentication is required.
  • Bearer Token: Includes the token in the request header using the format Authorization: Bearer <token>.
  • API Key: Includes a predefined key in a request header or parameter, which the server validates upon receipt.

Setting Authentication in an API Automation Test Case Script

  1. On the Testing Case > API Automation page, click the name of the test case to be edited.
  2. Click the Scripting tab.
  3. Click .
  4. In the displayed dialog box, click the authentication mode drop-down list.
  5. Select one of the following modes and configure it by referring to the following information:

    • No Auth: No authentication information is required.
    • Bearer Token: Enter the authentication information in the token text box. Or use built-in functions, environment parameters, and local parameters. Up to 20,000 characters are supported.
    • API Key: Enter a name and a value. Both support up to 20,000 characters. The name can contain only letters, digits, underscores (_), and hyphens (-). The value can use built-in functions, environment parameters, and local parameters.

  6. Click OK.

Setting Authentication in a URL Request

  1. On the Testing Case > API Automation page, click the name of the test case to be edited.
  2. Click the Scripting tab.
  3. On the bottom of the page, click URL Request to generate a test step.
  4. Click the Authentication tab.
  5. Select one of the following authentication modes from the drop-down list box:

    • Inherit: (Default) Inherits the authentication settings of the API automation test case script set in Setting Authentication in an API Automation Test Case Script.
    • No Auth: No authentication information is required.
    • Bearer Token: Enter the authentication information in the token text box. Or use built-in functions, environment parameters, and local parameters. Up to 20,000 characters are supported.
    • API Key: Enter a name and a value. Both support up to 20,000 characters. The name can contain only letters, digits, underscores (_), and hyphens (-). The value can use built-in functions, environment parameters, and local parameters.

  6. Click on the top of the test step to save the configuration.