Skip to content

API client

This page describes APIKeyClient class which is implementation of API client class that uses API key for authentication.

APIKeyClient

Bases: APIClient

API client class that uses API key for authentication.

Attributes:

Name Type Description
url str

Typhoon Test Hub url

api_key str

API key for authentication

get_request_headers()

Generates dictionary with request header parameters.

Returns:

Name Type Description
header dict

Request header parameters

test_credentials()

Tests if provided credentials are valid.

Returns:

Name Type Description
status bool

Indicator whether provided credentials are valid