here.platform.api.base_api module#

This module contains a BaseApi class to perform API operations.

class here.platform.api.base_api.BaseApi(platform_config: PlatformConfig, application_config: ApplicationConfig, auth: Auth | None, proxies: dict | None = None)[source]#

Bases: object

This class provides access to some Restful API operations.

delete(url: str, params: dict | None = None, headers: dict | None = None, **kwargs) → Response[source]#

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

Parameters:

  • url – URL of the API

  • params – parameters to pass to the API.

  • headers – Request headers. Defaults to the api headers property.

  • kwargs – Optional arguments that request takes.

Returns:

response from the API.

format_url(base_url: str, path: str) → str[source]#

Formats the URL based on the base URL and path.

Parameters:

  • base_url – The base URL for the request.

  • path – The path for the URL. This is expected to have the leading ‘/’.

Returns:

The formatted URL.

get(url: str, params: dict | None = None, headers: dict | None = None, **kwargs) → Response[source]#

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

Parameters:

  • url – URL of the API.

  • params – Parameters to pass to the API.

  • headers – Request headers. Defaults to the Api headers property.

  • kwargs – Optional arguments that request takes.

Returns:

response from the API.

head(url: str, params: dict | None = None, headers: dict | None = None, **kwargs) → Response[source]#

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

Parameters:

  • url – URL of the API.

  • params – Parameters to pass to the API.

  • headers – Request headers. Defaults to the api headers property.

  • kwargs – Optional arguments that request takes.

Returns:

response from the API.

property headers: dict#

Return HTTP request headers with Bearer token in Authorization field.

Returns:

authorization tokens

patch(url: str, data: dict | list | bytes | str | None = None, params: dict | None = None, headers: dict | None = None, **kwargs) → Response[source]#

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

Parameters:

  • url – URL of the API

  • data – Patch data for http request.

  • params – Parameters to pass to the API.

  • headers – Request headers. Defaults to the api headers property.

  • kwargs – Optional arguments that request takes.

Returns:

response from the API.

post(url: str, data: dict | list | bytes | str | None = None, params: dict | None = None, headers: dict | None = None, **kwargs) → Response[source]#

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

Parameters:

  • url – URL of the API.

  • data – Post data for http request.

  • params – Parameters to pass to the API.

  • headers – Request headers. Defaults to the api headers property.

  • kwargs – Optional arguments that request takes.

Returns:

response from the API.

put(url: str, data: dict | list | bytes | str | None = None, params: dict | None = None, headers: dict | None = None, **kwargs) → Response[source]#

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

Parameters:

  • url – URL of the API

  • data – Put data for http request.

  • params – Parameters to pass to the API.

  • headers – Request headers. Defaults to the api headers property.

  • kwargs – Optional arguments that request takes.

Returns:

response from the API.

request(method: str, url: str, headers: dict | None = None, stream: bool = False, **kwargs) → Response[source]#

Performs a request of an API at a specified URL with a backoff. :param method: The HTTP method to perform. :param url: URL of the API :param headers: Request headers. Defaults to the api headers property. :param stream: whether to stream data. :param kwargs: Optional arguments that request takes. :return: response from the API.