Configure API Integration

1. Generate API Credentials

AgileTest provides exposed REST APIs that allow external systems to access and interact with AgileTest data. These APIs enable you to:

Integrate AgileTest with CI/CD pipelines
Synchronize test data with external testing systems
Retrieve testing information for dashboards or reporting tools
Support AgileTest AI Agents that operate via REST APIs
…

To ensure secure access, API requests require authentication using Client ID and Client Secret, which are used to generate an Authentication Token.

As a user, you can create and manage Client IDs and Client Secrets, which are used to request credential tokens for accessing exposed APIs.

You can create and copy the API directly, without the help of Jira or project admins.

You need to get the Client ID and Client Secret of your instance.

How to get the Client ID and Client Secret in AgileTest

Click on your avatar.
Choose “AgileTest API Integration”.

Create and Copy your Client ID and Client Secret

Click “Generate API token”
Now you can see your Client ID and Client Secret.

Each user can only generate 1 API key for a single instance. In case of need for a new API key for another instance, please remove the existing one.

2. Deploy API Credentials

After generating your API credentials, they are created and saved in the system, but not yet activated for use. To ensure the credentials are applied and ready for integration, you need to deploy them.

Copy the Client ID and Client Secret you have generated.
Navigate to the Authentication section of the API Documentation and click the 🔽 button.

Click “Try it out” in the Authentication section.

Paste your copied Client ID and Client Secret in the Edit Value space. Then, click the “Execute” button.

The system will provide an Authentication Token as a response. Copy the token in the Response body part.

Paste it to the Authorize button or any locker icon as per your reference.

Prepend the token with "JWT " (including a space after JWT) to activate its functionality properly. Click Authorize to finish.

Now, you can select each feature field in the provided API Document for further instructions and personalization.

Should you need any assistance or further AgileTest inquiries, contact our 24/7 Support Desk!