Epilot is the digital foundation for sales, service, network and implementation processes in the context of the energy transition. This SDK is for the Epilot Journey, Entity and Automation APIs. Please see the Epilot developer documentation for more information.

pip install epilotapi

To call epilot APIs, requests must be authorized using a valid Access Token.

The access token should be passed in the Authorization request header.

Authorization: Bearer <your-access-token>

Users logged into the epilot 360 portal can manage their Access Tokens from Settings > Access Tokens.

Creating access tokens requires the token:create permission.

Access Token API Authenticated users can generate long-term access tokens for 3rd party applications using the epilot Access Token API createAccessToken operation.

POST /v1/access-tokens
{
  "name": "Token for my application"
}

Optionally, you can pass a list of Role IDs, to define the roles the access token will have access to. By default, the access token inherits the caller's roles.

POST /v1/access-tokens
{
  "name": "Postman Access Token",
  "assume_roles": ["123:owner"]
}

Each Access Token generated via the API gets a generated a unique ID.

// 201 - success
{
  "id": "api_5ZugdRXasLfWBypHi93Fk",
  "created_at": "2019-08-24T14:15:22Z",
  "name": "Postman Access Token",
  "assignments": ["123:owner"]
}

Access tokens may also be revoked using the revokeAccessToken operation

DELETE /v1/access-tokens/api_5ZugdRXasLfWBypHi93Fk
// 200 - success
{
  "id": "api_5ZugdRXasLfWBypHi93Fk",
  "created_at": "2019-08-24T14:15:22Z",
  "name": "Postman Access Token",
  "assignments": ["123:owner"]
}

import epilotapi
from epilotapi.models import operations, shared

s = epilotapi.EpilotAPI()
s.config_security(
    security=shared.Security(
        epilot_auth=shared.SchemeEpilotAuth(
            authorization="Bearer YOUR_BEARER_TOKEN_HERE",
        ),
    )
)
   
req = operations.AttachActivityRequest(
    path_params=operations.AttachActivityPathParams(
        id="unde",
    ),
    query_params=operations.AttachActivityQueryParams(
        entities=[
            "porro",
            "nulla",
            "id",
        ],
    ),
)
    
res = s.activity.attach_activity(req)

if res.activity_item is not None:
    # handle response

• attach_activity - attachActivity
• create_activity - createActivity
• get_activity - getActivity
• get_entity_activity_feed - getEntityActivityFeed

• autocomplete - autocomplete
• create_entity - createEntity
• delete_entity - deleteEntity
• get_entity - getEntity
• search_entities - searchEntities
• update_entity - updateEntity
• upsert_entity - upsertEntity

• export_entities - exportEntities
• import_entities - importEntities

• create_journey - createJourney
• get_journey - getJourney
• get_journeys_by_org_id - getJourneysByOrgId
• patch_update_journey - patchUpdateJourney
• remove_journey - removeJourney
• search_journeys - searchJourneys
• update_journey - updateJourney

• add_relations - addRelations
• delete_relation - deleteRelation
• get_relations - getRelations
• update_relation - updateRelation

• create_saved_view - createSavedView
• delete_saved_view - deleteSavedView
• get_saved_view - getSavedView
• list_saved_views - listSavedViews
• update_saved_view - updateSavedView

• create_new_schema_version - createNewSchemaVersion
• delete_schema_by_id - deleteSchemaById
• get_schema - getSchema
• get_schema_versions - getSchemaVersions
• list_schema_blueprints - listSchemaBlueprints
• list_schemas - listSchemas
• list_taxonomy_classifications_for_schema - listTaxonomyClassificationsForSchema

• get_taxonomy - getTaxonomy
• list_taxonomies - listTaxonomies
• taxonomies_classifications_search - taxonomiesClassificationsSearch
• taxonomy_autocomplete - taxonomyAutocomplete
• update_classifications_for_taxonomy - updateClassificationsForTaxonomy

• cancel_execution - cancelExecution
• get_execution - getExecution
• get_executions - getExecutions
• retrigger_action - retriggerAction
• start_execution - startExecution

• create_flow - createFlow
• delete_flow - deleteFlow
• get_flow - getFlow
• put_flow - putFlow
• search_flows - searchFlows