Session Instances

A Helios Session depends on properly established authentication procedures. See Authentication for more information. It also stores your authentication information and will fetch an API token. This token is required for any API queries.

Once a session has been created, the token will be written to a .helios_token file in your home directory. This token will be reused until it becomes invalid.

Creating a Session

If authentication is stored on your machine starting a session is simple. Create a Session instance without any inputs. The authentication information stored on your machine will automatically be applied.

import helios
sess = helios.Session()

This will automatically make a call to the start_session method to fetch the token.

If successful, the sess instance will now have all the authentication information needed to being using the core APIs.

Token Expiration

Restarting Python if your token expires while the SDK is in use is not necessary. Call start_session to perform the token verification process. This will acquire a new token if it has expired.

After the a token has been re-acquired you will need to create new core API instances using the session.

Reusing a Session

Creating a Session instance allows you to use a single instance across all Core APIs. This avoids multiple token verifications with the initialization of every Core API instance.

import helios
sess = helios.Session()
alerts = helios.Alerts(session=sess)
cameras = helios.Cameras(session=sess)

In the above code sess is started once and used across Alerts and Cameras.

Using a Custom env

When creating a Session instance an optional input variable, env, can be used for dynamic credential usage.

This optional input must consist of a dictionary containing all necessary information for authentication.

custom_env = {'helios_client_id': 'your ID key',
              'helios_client_secret': 'your secret key',
              'helios_api_url': 'optional API URL override'}
sess = helios.Session(env=custom_env)