Qase TestOps API V2 Client

Common errors

• ModuleNotFoundError: No module named 'qase_api_v2_client'

  cause The package was not installed or installed incorrectly. The PyPI package name is `qase-api-v2-client`, but the import name is `qase_api_v2_client`.
  fix Ensure you have installed the package correctly using `pip install qase-api-v2-client`.

• qase_api_v2_client.exceptions.ApiException: (401) Unauthorized

  cause The provided Qase API token (`QASE_API_TOKEN`) is either missing, invalid, or does not have sufficient permissions for the requested operation.
  fix Verify your `QASE_API_TOKEN` is correct, active, and has the necessary scope within your Qase TestOps account. Ensure it's correctly loaded into the `Configuration` object.

• qase_api_v2_client.exceptions.ApiException: (404) Not Found (or similar network error)

  cause This often indicates an incorrect API base URL. The `qase-api-v2-client` defaults to `v1`, but the client is designed for `v2` endpoints.
  fix Explicitly set `configuration.host = 'https://api.qase.io/v2'` (or your custom Qase V2 API URL) when initializing the `Configuration` object.

Warnings

• gotcha The `qase-api-v2-client` library, despite its name, defaults its `Configuration.host` to `https://api.qase.io/v1`. To use the Qase API V2, you *must* explicitly set `configuration.host = 'https://api.qase.io/v2'` or configure `QASE_API_BASE_URL` environment variable.
  Fix: Set `configuration.host = 'https://api.qase.io/v2'` or ensure `os.environ['QASE_API_BASE_URL'] = 'https://api.qase.io/v2'` before initializing the `Configuration`.
• breaking Migrating from a Qase API v1 client to `qase-api-v2-client` will involve significant breaking changes. API endpoints, request/response models, and method signatures are different, reflecting the V2 API specification.
  Fix: Review the Qase API V2 documentation and the `qase-api-v2-client` source code/examples for the new API structure and model definitions. Your existing V1 API calls will not work directly.
• gotcha This library is part of the `qase-python` monorepo. While it is a standalone install, updates to shared components (like `qase-python-commons`) or new API versions may prompt updates to this client, potentially changing method signatures or data models.
  Fix: Always check the release notes on GitHub for `qase-api-v2-client` specifically and the overall `qase-python` project when upgrading to new major or minor versions to anticipate changes.

Install

• pip install qase-api-v2-client Install stable version

Imports

• ApiClient

  from qase_api_v2_client import ApiClient

• Configuration

  from qase_api_v2_client import Configuration

• ProjectsApi

  from qase_api_v2_client.api.projects_api import ProjectsApi

  API services are found in `qase_api_v2_client.api.<service_name>_api`.
• ApiException

  from qase_api_v2_client.exceptions import ApiException

Quickstart

This quickstart demonstrates how to initialize the Qase API V2 client, authenticate using an API token (preferably from environment variables), and make a basic call to list projects. It explicitly highlights and corrects the common pitfall of the default API host.

import os
from qase_api_v2_client import ApiClient, Configuration
from qase_api_v2_client.api.projects_api import ProjectsApi
from qase_api_v2_client.exceptions import ApiException

# Configure API key authentication
configuration = Configuration()
configuration.api_key['TokenAuth'] = os.environ.get('QASE_API_TOKEN', 'YOUR_QASE_API_TOKEN_HERE')

# IMPORTANT: The client is named 'v2-client' but its default host is 'v1'.
# Explicitly set the host to the Qase API V2 endpoint.
configuration.host = os.environ.get('QASE_API_BASE_URL', 'https://api.qase.io/v2')

# Create an instance of the API client
api_client = ApiClient(configuration)

# Create an instance of a specific API service, e.g., ProjectsApi
projects_api = ProjectsApi(api_client)

try:
    # Example: List projects
    response = projects_api.get_projects()
    print(f"Successfully connected to Qase API V2. Found {response.total} projects.")
    if response.entities:
        print(f"First project: {response.entities[0].title} (Code: {response.entities[0].code})")
except ApiException as e:
    print(f"Error calling Qase API: {e.status} - {e.body}")
    if e.status == 401:
        print("Please check your QASE_API_TOKEN and ensure it's valid for the v2 API.")
    elif e.status == 404 and 'v1' in configuration.host:
        print("Consider changing QASE_API_BASE_URL to 'https://api.qase.io/v2'.")
except Exception as e:
    print(f"An unexpected error occurred: {e}")