Getting Started

Every journey starts with the first step. To ease your initial steps, we have compiled a brief getting started guide.

Your Developer Account

You need a developer account for our API Developer Programme. Please apply for a developer account if you do not have one already. Please note that the API Developer Programme is current only available for professional usage in a business context and not for private use. The application includes the agreement of our Terms and Conditions. Once your partnership is confirmed, you will get credentials to log into the Developer Portal and you will receice your client ID and secret from us.

Apply for access

Did we catch your interest? Would you like to become a partner in the Vaillant Group API Developer Programme? Then apply for access and we will be in contact with you soon!

Subscribe to an API product

Discover our API Products and chose the product that best suits your use case. After subscribing to the API product of your choice, you will have access to your subscription ID that you have to include in each request header.

Access to a heating system

You should have access to a Vaillant Group heating solution that is compatible with the API Developer Programme. Check out our compatility section to find out more. However, do not worry if you do not have a compatible system available. For integration and testing purposes we can provide you with access to a system simulation. Just drop us a line.

Connecting to the heating system

After performing your authorisation using the OAuth2.0 client credentials flow, you will receive your access token. To connect to one heating system, you need to know the Vaillant Group serial number of the gateway. A Vaillant Group serial number is a 28 characters long unique identifier that you have to use as a path parameter to access a specific heating system. During the trail phase, you will need to pass the serial numbers manually to us and we will grant you the access rights.

Rate limits

We have decided not to use absolute rate limits in our product packages. Instead, each product package features a concurrency limit that restricts how many API calls you can issue in parallel. Each API product contains a trial package with a limit of 2 concurrent requests that will allow you to test and integrate our APIs. Once you are ready to move to production, you can flexibly switch to our M (5 concurrent calls), L (20 concurrent calls) or XL (50 concurrent calls) packages. And if you decide to go beyond XL, just contact us and we will find an individual and customised solution for you.