Skip to content

Overview

Overview

You can use IIH Essentials Open API [pls adjust in the whole docu] to implement automations via e.g. scripting or to build custom applications based on IIH Essentials.

For more information see:

Endpoint availability

The endpoint of IIH Essentials varies depending on the environment.

From inside of the IED

If your application or script is running inside the IED in Docker, the IIHE API is accessible via the Docker network ‘proxy-redirect’. To communicate with it, the application or script must define this ‘external’ network using the ‘bridge’ driver.

147153039243-d2e828

Inside this network IIH Essentials is available under this URL:

http://edgeappdataservice:4203

From outside of the IED

If you are running an application or a script outside of the IED, your request must pass through the reverse proxy of the IED.

This requires an authentication, which can be obtained using the /login/direct route of the IED. For more information see the API specification IED API 2.0.0.

curl -X POST https://your.ied/device/edge/api/v2/login/direct -d '{"username": "you@example.com", "password": "yourPassword"}'

Using the obtained token, an API call can be created. The token has to be set as authToken inside the header:

curl -X GET https://{ip_or_address_of_ied}/iih-essentials/your-path --cookie authToken=your-auth-token

Outside of the IED IIH Essentials is available under this URL:

https://{ip_or_address_of_ied}/iih-essentials

API stability

Stability rule

At any given time, the API remains stable for at least one year.

With every release, some routes might be marked as deprecated with a deprecation date. From this date, the route will be supported for one year before being removed.

If you are an application provider or developer, you should monitor the API specification with each release. If your application uses deprecated routes, you should either:

  • Provide an update that avoids using the deprecated routes within one year. --or--
  • Inform customers not to update IIH Essentials if they wish to continue using your app.

Except where otherwise noted, content on this site is licensed under the Siemens Inner Source License .