here_location_services.platform.apis.api module

This module implements base class for low level api client.

class here_location_services.platform.apis.api.Api(access_token, proxies=None)

Bases: object

Base class for low level api calls.

Parameters

proxies (Optional[dict]) –

__init__(access_token, proxies=None)

Parameters

proxies (Optional[dict]) –

property headers: dict

Return HTTP request headers with Bearer token in Authorization field.

Returns

authorization tokens

post(url, data=None, params=None, headers=None, **kwargs)

Perform a post request of an API at a specified URL with backoff.

Parameters

• url (str) – URL of the API.

• data (Optional[Union[dict, list, bytes, str]]) – Post data for http request.

• params (Optional[dict]) – Parameters to pass to the API.

• headers (Optional[dict]) – Request headers. Defaults to the api headers property.

• kwargs – Optional arguments that request takes.

Returns

response from the API.

Return type

requests.models.Response

static raise_response_exception(resp)

Parse HTTP errors status code and raise necessary exceptions.

Parameters

resp (requests.models.Response) – An HTTP response to parse.

Raises

• TooManyRequestsException – If platform responds with HTTP 429.

• AuthenticationException – If platform responds with HTTP 401 or 403.

• Exception – If client responds with any other exception.

Return type

None