Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.energy-hub.io/llms.txt

Use this file to discover all available pages before exploring further.

Architecture

Setup your subscription and clients

Before you can get started and use the Energy Hub Alliance, you need to setup clients for the API and streaming clients.
Subscriptions, API keys and streaming clients can be created once you have access to the Partner Portal. To apply for access to the partner portal contact us at info@energy-hub-alliance.com.
To add a new subscription, you need to provide a application name and a redirect URL. The redirect URL is needed for the connect flow, to direct the user back to your application.
To authenticate to the Energy Hub API, you can create one or more API-keys. Make sure to store these API-keys safely, since they will be used to authenticate your application. The API keys are connected to your subscription.
To recieve streaming data, create a streaming client in the partner portal and configure your Kafka Broker to recieve messages.

Start developing

The Energy Hub Alliance provides a reference implementation, to help to you understand the general concepts like streaming and the implementation of the connect flow. Check out our Github.

API Reference

Check out the API reference to get used to concepts and understand the endpoints.

Connect Flow

Set up the connect flow in you application to onboard first energy devices.

Streaming

Set up and configure a streaming client.