EcoStruxure™ Retail Integrated Management Platform Alarms API

Alerts to ensure business continuity and move towards hyper-efficiency
Published by Schneider Electric

Features

  • How it works
  • Overview and usage
  • Discover the API through the Developer Portal
  • Authorization key for Production environment

How it works

A Schneider Electric customer/partner can remotely access to the alerts in Retail Integrated Management Platform cloud. Prior to accessing the alerts, the EcoStruxure™ Retail Integrated Management Platform must be connected to on-site systems, BMS or cloud software to collect data.

Before configuring the API, you need to:

  • Order a Retail Integrated Management Platform subscription allowing to access the API
  • Use the documentation to then configure the API.
  • How it works

    Overview and usage

    This API allows to retrieve alerts from any equipment, on site systems, BMS or cloud software connected to EcoStruxure for Retail Integrated Management Platform for a store or a group of stores.


    • It also enables you to retrieve advanced alerts that have been set in the Retail platform.
    • It leverages connectivity and data to help operators to be quickly alerted in case of an issue on an equipment, a parameter which is deviating or an abnormal situati

    Discover the API through the Developer Portal

    The Developer portal (Dev Portal) is an interactive portal where you can learn more about the API including the various parameters required.

    The Alarm system is a service that will generate alerts for configured abnormal conditions. The platform will generate alarms itself, and ingest alarms from other subsystems. Automatically generating an alert allows operators to understand the current condition of the control system, knowing that issues will be brought to their attention automatically.


    The Alarm API consists of two endpoints, alarms and events.

  • Events : This is a transaction log of all the transitions in the system
  • Alarms : This contains a list of all currently unresolved alarms in the platform
  • Authorization key for Production environment

    To be able to use the APIs from your own applications you will need to be authorized. Authorization is managed by using API Key which will be provided to you once your subscription is approved.

    Note: To use the API Key in your own application, add in your request header the following parameter : “Authorization: ”

    Unauthorised background image

    Your product is just steps away!

    Register for FREE to buy, get downloads and access free trials.

    Get Resources and Start FREE Trials

    Easy Product Activation with Your Account

    Products Saved to Personal Digital Library