Skip to main content
POST
/
v1.0.0
/
connections
/
hvacs
Connect URL for a HVAC vendor
curl --request POST \
  --url https://api.energy-hub.io/v1.0.0/connections/hvacs \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "redirectUrl": "https://www.redirectable-partners-website.com/v1.0.0/endpoint/bea09c5f-9d37-4562-b54a-dedb48d7aaf4",
  "vendor": "VIESSMANN",
  "userId": "896f9d5a-b618-48a2-98ae-957059bf1bc9"
}'
{
  "url": "https://svc-connect.energy-hub.io/bea09c5f-9d37-4562-b54a-dedb48d7aaf4/redirect"
}

Authorizations

​
X-API-KEY
string
header
required

API key used for authorization and authentication.

Query Parameters

​
theme
enum<string>
Available options:
DARK,
LIGHT
​
language
enum<string>
Available options:
ENGLISH,
GERMAN,
FRENCH
​
isUserGdprInformationProvided
boolean

Body

application/json

An object containing relevant information to link HVAC vendor accounts.

​
redirectUrl
string
required

The URL to which the user will be redirected.

Maximum length: 2048
Example:

"https://www.redirectable-partners-website.com/v1.0.0/endpoint/bea09c5f-9d37-4562-b54a-dedb48d7aaf4"

​
vendor
enum<string>
required

The vendor of the account to be added to the Energy Hub.

Available options:
VIESSMANN,
DAIKIN,
VAILLANT
​
userId
string
required

The ID of the user for which to create the connect session.

Maximum length: 50
Example:

"896f9d5a-b618-48a2-98ae-957059bf1bc9"

Response

Created

An object containing the URL which is used to redirect the user to the connect page or vendor login.

​
url
string
required

The URL to follow to redirect to connect page or IDP of the vendor.

Example:

"https://svc-connect.energy-hub.io/bea09c5f-9d37-4562-b54a-dedb48d7aaf4/redirect"