Solar API integration

This guide explains the minimum required flow to onboard a client and connect a solar installation using Clevergy’s Solar API.

Steps to create a solar client

1. Create the client: start by entering the client's personal data to generate a userId.

2. Create a home: use the userId to create a supply point, which will generate a houseId.

3. Connect the solar inverter: the available integration flow depends on the inverter manufacturer. Some providers support installer-based integrations, others require user authorization, and some support both methods.

   A. Installer credentials flow: the solar integration is configured directly from the Clevergy Portal using installer credentials. Once configured:

   • Retrieve installation data: use the name or plantCode to search for installation metadata, including the installationId, which will be needed to link it to the house
   • Obtain the houseId: use the userId to retrieve the client's houses, then select the houseId where you want to link the installation.
   • Link the solar installation to the house: finally, connect the solar installation using installationId to the houseId to enable your client monitoring of all inverter data, including energy production, consumption, real-time power, and solar savings.
   note

   Some providers may limit advanced capabilities, such as battery control, when using installer credentials.

   B. User credentials flow: use Clevergy's microfrontend to allow the user to securely connect their inverter. This requires the user token and the houseId.

Once the authorization is completed, the installation is automatically linked to the user’s home.

Accessing solar data

After the inverter is connected, solar data becomes available through the Connect API.

1. Get installation details: retrieve general information about the solar installation, including metadata and linked equipment

2. Get energy data: retrieve production, consumption and self-consumption breakdown.

3. Get power data: retrieve real-time power measurements.

4. Manage battery (if available): retrieve battery status and configure charge/discharge behavior.

Endpoints needed

createUser

createHouse

connectInstallation

getInstallations

getEnergyByHouseId

getPowerByHouseId