openapi-client

API for the Qiara home security system, extracted from decompiled Android APK. This API manages authentication, home nodes, video streaming, recording, pairing, and history.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.19.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/abruneau/qiara-python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/abruneau/qiara-python-sdk.git)

Then import the package:

import openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.qiara.co/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "https://api.qiara.co/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SessionAuth
configuration.api_key['SessionAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SessionAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.DefaultApi(api_client)
    x_hlcore_session_id = 'sess_1a2b3c4d5e6f' # str | Session ID obtained from the /login/new endpoint after successful authentication
    body = None # object | 

    try:
        # Control video recorder
        api_response = api_instance.control_video_recorder(x_hlcore_session_id, body)
        print("The response of DefaultApi->control_video_recorder:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->control_video_recorder: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.qiara.co/api/v1

Class	Method	HTTP request	Description
DefaultApi	control_video_recorder	POST /home/recorder_action	Control video recorder
DefaultApi	create_session	POST /login/new	Create new session
DefaultApi	delete_history	POST /home/delete_history	Delete history items
DefaultApi	delete_nodes	POST /home/delete	Delete nodes
DefaultApi	delete_video_recordings	POST /home/remove_records/720p	Delete video recordings
DefaultApi	get_challenge	GET /login/challenge	Get authentication challenge
DefaultApi	get_history	POST /home/history	Get event history
DefaultApi	get_nodes	POST /home/nodes	Get home nodes
DefaultApi	get_revision_update	GET /home/revision	Get revision update
DefaultApi	get_stream_snapshot	GET /home/stream/live.jpeg	Get live stream snapshot
DefaultApi	get_video_recordings	GET /home/recording/720p	Get video recordings
DefaultApi	manage_home_pairing	POST /home/pairing	Manage device pairing
DefaultApi	open_video_stream	POST /home/open_stream	Open video stream
DefaultApi	read_endpoints	POST /home/endpoints_read	Read endpoint values
DefaultApi	update_firmware	POST /home/fw_update	Update firmware
DefaultApi	update_revision	POST /home/revision	Update revision
DefaultApi	write_endpoints	POST /home/endpoints_write	Write endpoint values

Documentation For Models

• ApiBridgeError
• ApiChallenge
• ApiEndpointReadBody
• ApiEndpointReadBodyListInner
• ApiEndpointWriteBody
• ApiEndpointWriteBodyListInner
• ApiHistoryBody
• ApiHistoryResponse
• ApiNewSessionBody
• ApiNewSessionResponse
• ApiNodesResponse
• ApiPairingResponse
• ApiPairingStart
• ApiVideoStreamBody
• HistoryItem
• ManageHomePairingRequest
• Node
• ReadEndpoints200Response
• ReadEndpointsRequest
• WriteEndpointsRequest

Documentation For Authorization

Authentication schemes defined for the API:

SessionAuth

• Type: API key
• API key parameter name: x-hlcore-session-id
• Location: HTTP header

Author