System integration

NOTE: The functionality displayed in this topic might not be the same as what you see for your organization. Your Energy Hub feature plan subscription determines what functionality is available for this feature. For feature plan details, see Feature plans.

Overview

Share Energy Hub data with other applications through an application programming interface (API).

warning

inaccurate data results

● Do not incorrectly configure the software or the devices.
● Do not base your maintenance or service actions solely on messages and information displayed by the software.
● Do not rely solely on software messages and reports to determine if the system is functioning correctly or meeting all applicable standards and requirements.
● Consider the implications of unanticipated transmission delays or failures of communication links.

Failure to follow these instructions can result in death, serious injury, equipment damage, or permanent loss of data.

 

warning

HAZARD OF FIRE

● Do not use Energy Hub as a safety system for your facility.
● Do not rely solely on software messages and reports to determine the correct operation of your building systems.
● Do not base your maintenance or service actions solely on information provided by the software.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

 

warning

MISSED ALARMS

● Do not use Energy Hub for critical applications where human or equipment safety relies on alarming.
● Use reliable communication networks to connect devices, equipment, communication gateways, and Energy Hub.
● Consider the impact of unexpected transmission delays or communication failures.
● Configure alarms correctly.
● Do not disable notifications for important alarms.
● Send alarm notifications to more than one person.
● Check for email and mobile push notifications regularly.
● Do not solely rely on notifications. Check alarms regularly in Energy Hub.
● Do not let the Energy Hub subscriptions expire.

Failure to follow these instructions can result in death, serious injury, or equipment damage.

 

Features

Energy Hub API

[Web app only]

System integration provides an API that is based on the Open Authorization (OAuth) 2.0 protocol, an open, industry-standard framework for token-based authorization on the internet. This API gives access to energy system data in Energy Hub, including alarms. It can also be used to retrieve configuration data, such as details on the organization model.

Access client

For a client application to connect to the API, you need to create an access client in Energy Hub. An access client has a client ID, a client secret, a role, and access permissions. The client application then uses the access client credentials to connect to the API. You can create multiple access clients for multiple client applications that can access the API at the same time.

The following table gives more information on the access client details:

Property Description
Client ID The client ID is an auto-generated value that Energy Hub uses to identify the client application requesting access.
Client secret The client secret is an auto-generated 'password' that the client application uses to authenticate with Energy Hub.
Role The role determines which actions the client application can take in Energy Hub. This is similar to the user roles in Energy Hub.
Access permissions Access permissions determine which data the client application can access in Energy Hub. This is similar to the user access permissions in Energy Hub. For example, the "All My Organization" access permissions allow access to all data in the organization, but not data in other organizations.

There are no software-based alarm types for Energy Hub API. To learn more about alarming in Energy Hub, see Alarming.

Prerequisites

Verify that:

  • You have an active Energy Hub subscription to a Data-as-a-service (DaaS) feature plan or a regular plan with DaaS add-on. For information on subscriptions, see Energy Hub subscriptions.
  • The Integrations tab in Energy Hub Setup is visible. The tab is only displayed with a DaaS feature plan or add-on.

Configuration

Create an access client for each application that you want to integrate with Energy Hub.

For step-by-step instructions on this configuration task, see system integration tasks.

The Energy Hub API uses GraphQL as a query language. You can use any REST client application to connect to the API. For more information on the API, the Energy Hub data model, and GraphQL query details, see Energy Hub API Reference (requires a Schneider Electric ID login).