Overview

The Upkip platform APIs provide programmatic and secure access to platform raw data, process KPIs, and alarms and open the front for non-trivial third-party integrations over standard and open protocols.

The platform openness is supported by 4 mnemonically titled APIs to expose functionalities and allow the end user to freely control the access to data generated in their own environment. All APIs are available through OpenData endpoint with Swagger and protected by Azure API Management service.

These APIs are:

• Data API – raw telemetry data from machines that has been optimized using GraphQL interface for efficient data retrieval.
• Alerts API – provides information for alarms generated by system events, as well as alarms generated by the machines themselves.
• Analysis API – provide processed data, that is aggregated over time and contains information for machine and work order performance.
• Smart Things API – provides key information for the development of GUI for smart devices and dashboards for high-level monitoring purposes and exposes information for factory layout and basic summary data.