All Helios API methods require valid authentication and are protected using the OAuth 2.0 “client credentials” flow. The general process for authenticating requests involves first requesting an access token using the developer API key pair, and then requesting protected data using the access token. Request access if you would like to obtain an API key.

Using Environment Variables

  1. Add “helios_client_id”: “your ID key”

  2. Add “helios_client_secret”: “your secret key”

  3. Add “helios_api_url”: “API URL associated with your account credentials”

    • “helios_api_url” is optional.

Using an Authentication File

  1. Create a “.helios” directory in your home directory.

  2. Create a “credentials.json” file in your “.helios” directory.

  3. Copy and paste the following into the “credentials.json” file and fill in your authentication values.

    • “helios_api_url” is optional. If you do not need a custom API URL leave this out of your json file or set to null.
    "helios_client_id" : "your ID key" ,
    "helios_client_secret" : "your secret key",
    "helios_api_url" : null

For more information refer to the Helios authentication documentation.