opinum-api-connector 1.0.2

Package to interact with the Opinum API

This package simplifies the Opinum API calls.

No magic. You need to follow the Opinum Swagger Documentation for correct formatting of your requests

Be aware that this is a new package, certainly missing a lot of features. Feel free to contribute.

You first need to create an instance of the ApiConnector class with following parameters:

environment

a dictionary of environment variables

if None, ApiConnector uses your environment variables (os.environ)

Mandatory environment variables are:

• OPINUM_USERNAME: the Datahub user.
  TAKE CARE: if this user has access to multiple tenants and if you do not specify a tenant id, ApiConnector will use the last tenant used.
• OPINUM_PASSWORD: the password for the user
• OPINUM_CLIENT_ID: the client id for accessing the API
• OPINUM_SECRET the corresponding secret

Optional environment variables are:

• OPINUM_API_URL: another API URL than the Europe SaaS one (https://api.opinum.com)
• OPINUM_AUTH_URL: another authentication URL than the Europe SaaS one (https://identity.opinum.com)
• DEFAULT_PUSH_URL: another push URL than the Europe SaaS one (https://push.opinum.com)
• OPINUM_SCOPE: the scope of you session (default: "opisense-api")
  if you want to push data, the scope should be "opisense-api push-data"

account_id

one of the tenant ids available for the Datahub user (default: None)

retries_when_connection_failure

number of extra attempts when no 200 or 204 return code (default: 0, maximum: 5)

Once you have your ApiConnector instance, you may use the class methods

• get
• post
• put
• delete

All keyword arguments will be converted to path parameters in the API call with one important exception, the data keyword referring to the body of your call.

There are two other class methods for data pushing because we have another API for this

• push_data
• push_dataframe_data

There is a little bit of magic with the method multi_thread_request_on_path that splits a list of parameters Allowing to make parallel calls.