BuildingMinds API

This page introduces the BuildingMinds API.

BuildingMinds Platform Overview

BuildingMinds enhances real estate portfolio performance, aligns business needs with sustainability goals and empowers your organization with full data control. The platform expedites a portfolio's journey toward net-zero carbon emissions and assists in daily building management.


BM API

BuildingMinds API is a interface that enables pushing (onboarding) Digital Twin building entities in specific formats to its Real Estate portfolio on the BuildingMinds platform. The API allows customers to push data to the BuildingMinds Platform using their 3rd party application via:

  • REST API, a widely used and easy integration
  • JSON format, a standard file and data interchange format

This service can be enabled by your BuildingMinds Key Account representative.

Technical description of the BuildingMinds API are provided via respective subpages, i.e. address, etc.


Base URL

Base URL of BuildingMinds API: [https://api.dev.onbuildingminds.com/api/digitaltwinintegration]


Authentication

REST API identifies 3rd party applications using API key authorization. An application must pass BuildingMinds API key in all requests in the request header authorization field. All requests should be made via Secure Sockets Layer (SSL).

API keys are unique and granted per user or BuildingMinds tenant. There are two API keys per user and the keys have validity dates. Two key mechanisms make a key renewing possible while the application uses the other key.

  • Step 1: Create an API key to generate a token from BM platform or through API call.
  • Step 2: To generate a token through API, send a POST request to [https://login.microsoftonline.com/tstbuildingminds.onmicrosoft.com/oauth2/v2.0/token] with valid credentials.
  • Step 3: The Token generated must be passed as a bearer token for each request made.

Batch ID in response

When data is pushed in a single request using BuildingMinds API, a Batch ID is returned in case of a successful post.

User can use this Batch ID to see the status of the records pushed in this batch.

More details on that can be found on the Batch page.


Error handling

BuildingMinds API returns an HTTP status code for every request. A 2xx status code indicates success, whereas a 4xx or 5xx status code indicate an error.

Status CodeDescription
200Success
400Validation error: An accompanying error message will explain further
401Authentication error: The credentials were missing, incorrect or expired
403Authentication error: The current authenticated user has no access to this resource
404Invalid endpoint: The endpoint requested is invalid, or the resource requested, such as a meter, does not exist.
405The HTTP method used for this endpoint is invalid.
429Too many requests: The client has exceeded our rate limiting threshold.
5xxAn error has occurred within the server and the request couldn't be completed.
503We're experiencing temporary server issues. Please try again.

When an API request fails, it will be accompanied by an explanatory message.
For example, an error might look like this: {code: 404, message: "Resource not found"}