Generating an API key

The API for WellCube is a REST API. You can generate API keys in the “Connect with Ecosystem” section. WellCube works with your existing third-party building and workplace management platforms. WellCube has an open API that simplifies the connection between WellCube and partner systems. 

API key data 

The datasets that you can access via API vary based on your role. Organization admins can see all data across the organization, but site admins can only see data that pertains to their specific site. 

The API provides access to the latest raw data from the devices and/or historic data summarized over a period of time.

Generate an API key

Clicking “generate api key” will prompt you to enter notes about the key you’re creating. We recommend that your notes help you remember the specific use case for that key. Once you’ve entered notes, select continue. The new API key will be added to the table below. 

The API keys that you generate are specific to your account; another user cannot log in with their own credentials and access that same API key. Each API key you generate will be saved, so you can come back to each of the unique keys you’ve created. 

When you generate an API key, the system saves your UserID, the site the key was generated for and the organization the site belongs to. Additional data about monthly calls is also represented here.

Using the API key 

When you’ve created an API key, you’ll need to use this guide to use the API key. If you have any issues, contact your technical team or your technical sales manager for assistance. 

You can enhance your building management systems (BMS) with localized data insights and leverage data to inform building-wide automations, which can help you improve the health of the building environment and the well-being of the occupants within. WellCube’s data may help you optimize building performance and achieve energy savings.