Getting Started

TestFiesta provides a RESTful API that allows you to programmatically interact with your test cases, test runs, and other resources. This guide will help you get started with using our API.

Authentication

All API requests must be authenticated using an API token. This token should be included in the Authorization header of your HTTP requests using the Bearer authentication scheme:

Authorization: Bearer your_api_token_here

Creating an API Token

First, log in to your TestFiesta account.

On the top navigation bar, there is a user dropdown menu. Click on it and select "Settings".

On the settings page, navigate to the "API Keys" section.

After clicking on the "Create API key" button, a slide-out form will open.

Fill in the form with the following details:

• Give your token a descriptive name

• Set an expiration date. You can also customize the expiration date if not available on the dropdown using a custom date picker in the form by choosing "Custom Date" option. Also you can set the token to never expire by choosing "No expiration" option.

• Set the token permissions. You can select the permissions you want to grant to the API key.

After you fill in the form, click on the "Create" button. A dialog will open asking you to copy the API key. API Key is prefixed with testfiesta_. You can use this API key in your HTTP requests. Click on the "I've saved my API code" checkbox and then click "Got it" to close the dialog after you have copied the API key.

⚠️ Important: Keep your API token secure and never share it. If your token is compromised, revoke it immediately and create a new one.

Pagination

API responses that return a list of items (e.g., test cases, test runs) are paginated. The response format includes the pagination object with the following properties:

• count: Total number of items

• items: Array of items (e.g., test cases, test runs)

Query Parameters

• limit: Number of items per page

• offset: Offset of the first item in the current page

Example

GET /v1/{handle}/projects/{key}/cases?limit=10&offset=0

Here is the example response:

{
  "count": 10,
  "items": [
    {
      "uid": 1,
      "name": "Test Case 1",
      "description": "Description of Test Case 1",
      "priority": 1,
      "status": 1,
    },
    {
      "uid": 2,
      "name": "Test Case 2",
      "description": "Description of Test Case 2",
      "priority": 1,
      "status": 1,
    }
  ]
}

Next Steps

• Check out our API Endpoints documentation for detailed information about available endpoints.