Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 1.64 KB

client.md

File metadata and controls

38 lines (27 loc) · 1.64 KB

Client Class Documentation

The following parameters are configurable for the API Client:

Parameter Type Description
apikey string API Key can be copied from your dashboard
http_client_instance HttpClient The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
timeout float The value to use for connection timeout.
Default: 60
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ['GET', 'PUT']

The API client can be initialized as follows:

from firstlanguageapi.firstlanguageapi_client import FirstlanguageapiClient
from firstlanguageapi.configuration import Environment

client = FirstlanguageapiClient(
    apikey='apikey',
    environment=Environment.PRODUCTION,)

FirstLanguage API Client

The gateway for the SDK. This class acts as a factory for the Controllers and also holds the configuration of the SDK.

Controllers

Name Description
basic_ap_is Gets BasicAPIsController
advanced_ap_is Gets AdvancedAPIsController