Authentication

The client can be authenticated against the API using either OAuth (personal credentials) or API Keys.

OAuth Authentication

Pre requisites

The Azure CLI simplifies the process of acquiring an access token that can be used when making requests. Follow How to install the Azure CLI if you haven’t installed it yet.

Signing in with the Azure CLI

In your terminal run:

az login --scope api://beta.optimeering.com/.default --allow-no-subscriptions

Configuring the Client

The client will automatically use the credentials gained from the step above, so all you have to do is create it with the default configuration:

from optimeering_beta import OptimeeringClient
client = OptimeeringClient()

API Key Authentication

Pre requisites

You will need to first generate an API Key. The easiest way to do that is by using the /api/access/apikey/create

Configuring the Client

from optimeering_beta import Configuration, OptimeeringClient
configuration = Configuration(api_key="SecretKeyHere")
client = OptimeeringClient(configuration=configuration)