EnergyVille API Management

Quick Start

To make use of the API's hosted in this API management service, a user specific subscription is required.

Sign in and create a subscription as explained in the following sections.

Sign in

• Click on the Sign in link on the top-right to browse to the Sign in page

• Click on the Sign in or Sign up button

• Sign in as follows:

  • EnergyVille or VITO users: sign in using the EnergyVille or VITO button 

  • External users: sign in using the email address and password of your SmarThor account

Create a subscription

Once signed in, users can create a subscription for each API they would like to use.

E.g., to subscribe to the SmarThor API, perform the following steps:

• Navigate to the Products page via the link in the top-right

• Click on the SmarThorDc product

• Enter a name for the subscription (e.g., smarthor-dc-{firstname}-{lastname})

• Click Subscribe

• You are forwarded to the Profile page, which lists all your subscriptions and associated subscription keys.

Copy either the primary or secondary key and use this in your API requests.

Trying out API endpoints

To test an API endpoint to do following:

• Navigate to the APIs page via the link in the top-right

• Click on you API of choice to access its OpenAPI documentation page

• Select one of the API operations on the left side of the page

• Click the Try this operation button to open up the request panel on the right

  • Note that your subscription key is automatically filled in

• Provide any required parameter values to create a valid request

• Click the Send button to send an HTTP request

• If all goes well, an HTTP response will be shown