The Dalux API can be used to interact with data and functions inside of the Dalux software by using an external interface to communicate with the software. We currently support basic API uses like the GET, POST, and PATCH functions.
This means that you can retrieve information inside the system and extract it (GET), insert data into the system (POST), and change data (PATCH).
Table of contents
How to use the Dalux API
Important
We only recommend using our APIs if you have experience with connecting to and using APIs. Dalux does not offer consultation or assistance with code or use cases on the client side of our APIs or fixing issues related to their use.
User rights
To use the Dalux API, you need to have a company license. If you have a company license, contact support at support@dalux.com to get an API key generated.
SwaggerHub
The Dalux APIs and documentation are publicly available on SwaggerHub:
API Documentation and Design Tools for Teams | Swagger
You can find the Dalux API for Build and FM here:
- Build: https://app.swaggerhub.com/apis-docs/Dalux/DaluxBuild-api/
- FM: https://app.swaggerhub.com/apis-docs/Dalux/DaluxFM-API/
Before using the APIs
Before starting the setup of the APIs please read the documentation on getting started with the APIs, found here:
https://app.swaggerhub.com/apis-docs/Dalux/GettingStarted/
The documentation provides information about the available endpoints, potential request bodies, and also expected responses for successful and unsuccessful operations.
(Click the image to enhance)
Updates to the API
User rights
To get updates on changes to the API, you need to create a free account on their website:
To make sure that you stay up to date with changes made to the API, turn on notifications for the different pages on SwaggerHub. To do so, use the search string to see all the Dalux pages: 'owner:Dalux'.
Then click the notification icon (bell) for the pages that you would like to get notifications from:
(Click the image to enhance)