API & SDK Catalogue¶

This vertical enables you to store master data describing airports.

This vertical deals with various asset-related operational data such as time series.

This vertical deals with baggage-related operational data.

This vertical deals with various container-related operational data.

This vertical deals with various types of flight-related operational data.

ANYbotics offers robotic solutions for automated industrial inspections. These robotic solutions perform routine condition monitoring tasks based on our legged robotic platforms, ANYmal and the Ex-certified ANYmal X.

Siemens battery passport platform REST API provides machine-to-machine exchange in order to manage product passports

The Building Operations API enables you to read data from data points or issue commands to actuator points.

The Building Structure API enables you to create and manage a structural representation of your buildings in Building X.

The Accounts API enables you, or rather the calling entity, the machine user to discover in which partitions it has access

The Fire API enables you or rather the calling entity, the machine user to get all events of site if it has access to the partition of the site.

Security Activities API enables user to retrieve events, alarms and user operation produced from access system and security manager services.

The Identities and Privileges API enables you to create and manage Identities and assign configured privileges to an identity.

The Point Value Ingest API enables you to set value of a Point. The data that is measured by data points is called point values.

The Building Geometry API enables you to create and interact with 2D geometry of building floorplans.

The Energy API enables you to read energy consumption, emission, or cost data for a location or a meter in the granularity and for the period of interest.

The Lifecycle Twin API enables you to create and manage various objects in the Lifecycle Twin.

A REST API for accessing information from COMOS

The Charger Status API enables you to read Charger & Connector availability status.

The Charger Control API enables you to list, update power limits of a Charger.

The Remote Command API enables you to send commands to a remote charger.

Reservations API allow users to manage connector reservations for charging.

Reservations API allow users to manage connector reservations for charging.

The Transaction Management API enables you to fetch all the transaction details for a selected time duration.

The VDV-261 API facilitates an interface that allows the EV (Electric Vehicle) to communicate and send VDV-261 parameters to the DepotFinity backend.

With the Drivetrain Analyzer Cloud app and the plug-and-play Connection Module IOT, you always have a detailed overview of the current health state of your system from different perspectives.

Edge App SDK provides ease for seamlessly developing edge apps .

Retrieve occupancy data for areas and desks.

Retrieve data locations of assets in a building.

View the list of campuses, buildings, and floors in an organization.

Groups of devices on a floor as defined in Enlighted Manage.

Obtain Sensor details including light profile, location, energy consumption, dim level, etc.

Obtain Plugload details by floor or area including energy consumption, and status.

Obtain the list of BLE sensors and set BLE Mode for sensors.

Control lights in a conference room using scenes.

Set color temperature and light level for Tunable White fixtures.

Get energy savings, temperature, light levels and power for all sensors on a floor.

Send emergency lighting commands, get emergency status from sensors, and test emergency drivers.

Contribute to energy load reduction and savings during peak demand time and public holidays.

Documentation of the API used to manage the Asset Models, which work as entry point for any further interaction with the assets

Documentation of the API used to trigger the Device Discovery, which is necessary to find devices.

Documentation of the API used to onboard new gateways into CDM.

Industrial Asset Hub Authorization API.

Industrial Asset Hub User Configuration API.

Southbound API of the WFX (Workflow Executor) Service.

Industrial Asset Hub Remote Access API.

Asset links act as adapters/drivers, between the Asset Gateway and the field devices. This SDK already includes the gRPC interfaces for the IAH use cases.

Use the IEM API to automate tasks, such as IED onboarding or Industrial Edge Application management.

This document provides API specs for Admin user. The specification is compatible starting from version 1.4.3 of the IEM.

IE Device APIs offer the possibility to manage the lifecycle of the IE Device itself, list its resources and publish notifications.

The application stores data in secure storage in key-value pairs, where the unique key is used to identify each value. An application can have multiple key-value pairs, where each key is unique to its own application. Each application has a unique set of key-value pairs.

IE Device OIDC provider APIs offer the possibility to manage OIDC provider.

The Network Service is a gRPC & Go based network configuration service. The network settings of the Edge Devices are configured through this service.

The NTP Service is a gRPC & Go based NTP configurator microservice for Edge Devices.

The Onboard Service is a gRPC & Go based Edge Core activator. This service communicates with all other services and provides the necessary configurations for the Edge Device to successfully onboard.

The System Service is a gRPC & Go based system resource tracker and system controller.

Protocol Documentation

Industrial Edge Control (IECTL) is a Command Line Interface to interact with Industrial Edge and its components.

The Flow Creator Configurator REST APIs allow you to configure flows, files, and nodes on Flow Creator instances running on multiple IE devices.

Public API documentation for IE Runtime Service Registry. Service Registry serves as a centralized directory where information about available services and their locations is stored.

Image Connector Applications Interface Specification

The Industrial Edge Common Databus Payload Format describes how connectors of different sources should publish data to the Databus.

Interact with the different endpoints of the IIH Essentials.

TypeScript/JavaScript Community SDK for Industrial IoT APIs.

Command Line Interface for Industrial IoT APIs.

Starting point for custom field to cloud connectivity implementation in node.js.

A Node-RED node which can be used to upload the time series data, files and events to the cloud.

Chrome extension which simplifies development tasks for which you need to use the SESSION and XSRF-TOKEN to access Industrial IoT APIs.

Development Kit for PROFINET RT/IRT controllers and RT devices and ERTEC 2000P Evaluation Kit.

Manages Environments, users and groups within Insights Hub

Secure Data Sharing (SDS) enables you to create and manage fine-grained access rights

Message Broker is a service that enables asynchronous communication in the Industrial IoT platform.

The OAuth Authorization Server provides APIs for authentication and authorization.

A service to manage an environment (tenant), its related subtenants, as well as related data.

Grant your application access to tenant data.

Information about ap usage for billing, reporting and quota checking purposes.

File management for files related to assets.

Create, read update and delete time series data.

Notification about arrival of new time series data.

Aggregated summaries of numeric time series data.

Import large amounts of data into Insights Hub.

Store structured and unstructured data in its native format.

API to onboard, offboard, update and delete agents.

API to onboard, offboard, update and delete agents.

Send data from shop floor devices to the cloud.

Send data from shop floor devices to the cloud via MQTT.

Manage certificates for secure connection of the MQTT Agents.

Manage Industrial IoT Assets in InsightsHub.

Upload Industrial IoT Data according to the OPC UA PubSub Specification.

Execute commands on shopfloor devices.

Create digital representation of your shopfloor devices.

Notifications about changes in the asset model.

The Event Management Service is used to capture events generated by devices in Insights Hub.

Notification about changes in event objects.

Send email, SMS or push notifications to consumers.

Basic digital workflow for work requests (maintenance, repair, inspection and incident handling).

Visual data flow programming in Industrial IoT.

Define Rules, triggers and actions on your digital assets.

Upload and download data for any purpose.

Essential functionalities for a data-driven analysis of event data.

Store single file models, algorithms, scripts docker images and training or validation data for ML or AI tasks.

The Data Management related APIs handles the entire workflow of data registration and preparation for data contextualization.

Query contextualized data in Insights Hub.

End-to-end capability to import/create, update or delete entire ontological model.

The Insights Hub Monitor Plugin SDK enables web developers to create plugins for Insights Hub Operations Insight.

Java clients for Industrial IoT APIs.

Node.js clients for Industrial IoT APIs.

Python clients for Industrial IoT APIs.

Connectivity Library written in C which allows a client application to exchange data with Siemens Industrial IoT Platform.

Design language for the overall look and feel of Insights Hub and Industrial IoT.

Integrate with Mcenter applications for instrumenting CNC shop floor resource management tasks and accessing shop floor data via REST APIs and MQTT.

Nurse Call System API let us integrate nurse call, color code call, restroom call data from Nurse call System to Ward Manager.

OT Companion Asset Management API enables you to create and manage an asset for your Location

OT Companion Protection Settings API allows you to retrieve the assets with protection settings.

APIs and services for project teams and owner-operators to create, visualize, and analyze the digital twin of their asset(s).

COMOS Walkinside Service enables the use of virtual reality to create a simulated environment and to provide trainings in a safe and controlled environment.

Develop applications in product design, manufacturing and analysis with Parasolid — the leading 3D geometric modeling component, used in Siemens applications and licensed to 200 independent software vendors.

Enhance your CAD, CAM and CAE software applications with D-Cubed components for parametric sketching, assembly constraints, motion simulation, collision detection and hidden line drawing.

Optimize robotics simulation and digital mock-up in a wide range of industrial applications with Kineo components for automatic path planning, high-speed collision detection and predictive cable performance.

Find and reuse similar parts, no matter how they have been named, with Geolus Shape Search to enhance processes including design, procurement, part management and classification.

Implement 3D visualization in your applications according to customer needs. Whether it's photorealistic rendering or engineering-oriented graphics with annotation, sectioning, and measurement, we have the 3D visualization SDK to meet your needs.

Create, edit and evaluate finite element models of complex products/systems using advanced CAE pre- and postprocessors to model components, assemblies or systems.

Add value to your hardware and software solutions with our low-cost, easy-to-use computer-aided design (CAD) feature base – customized with your brand look and feel.

Access the rich content of JT data in your applications with the JT Open Toolkit, a C++ API for reading and writing ISO-compliant JT files.

View and interact with 3D data on your choice of desktop/mobile platform using JT2Go — our free viewer for JT and Parasolid XT data.

Represent rich product data explicitly and via references with PLM XML, a lightweight, flexible mechanism for transporting product data.

Lets developers connect with Polarion via endpoints to integrate other tools in their toolchain, automate routine tasks, or create novel solutions tailored to a custom workflow.

The Product Information Hub is offering comprehensive product data and lifecycle information for SIEMENS and other manufacturers through a unified, standardized interface.

The Railigent X Train API allows to retrieve real-time information about rolling stock assets of eligible fleets. Railigent X uses cloud technology to normalize asset information across multiple fleets to provide a unified access interface.

The APM RailXplore Fusion service API allows to retrieve real-time information about different types of asset information such as Events, Alarms, and Device information.

Web browser playground for iX react starter app.

Siemens API Catalogue is available on the Public API Network hosted by Postman.

Take a look at the live Node-RED flow examples which are sending the industrial OPC UA or MQTT Data to the cloud platform.

Try out how Industrial Edge Management system, edge devices and edge apps work!

The Carbon Footprint Indicator for Transportation web service generates a standard multi modal routing proposal and calculates transport emissions.

Create financing proposals for your customers straight from your platform.

The Procurement API, part of SiGREEN’s suite of REST APIs, provides endpoints for managing components, suppliers, and component-level emissions within procurement processes for your company.

The Product API, part of SiGREEN’s suite of REST APIs, provides endpoints for managing products and Bills of Materials (BOM) for your company.

The MyTasks API, part of SiGREEN’s suite of REST APIs, provides endpoints for managing incoming and outgoing PCF requests for your company.

The PCF API, part of SiGREEN’s suite of REST APIs, provides endpoints for creating the Product Carbon Footprint (PCF) of your products on SiGREEN.

ST (Structured Text) examples, libraries, tutorials, code snippets and product templates for SIMATIC AX

With the SITRANS SCM IQ API you can get your latest asset condition and automate the processing of event information of your plant's mechanical components.

Calculation of product costs and carbon footprint