Introduction and Principle

Introduction

A REST API (Representational State Transfer Application Programming Interface) is an interface that allows web services and external applications to be integrated into an existing system.

It is based on the principles of REST architecture and enables standardized communication between different systems.

By using HTTP methods such as GET and POST, data can be exchanged and functions of the LOGIKEDITOR can be accessed. This allows external applications and systems to be flexibly integrated into automation processes.

The use of standardized web technologies simplifies the extension of existing applications and supports interoperability between different systems.

Principle

The REST API is integrated directly into the LOGIKEDITOR. This allows requests not only to be forwarded to the KNX system, but also to address functions within the LOGIKEDITOR, for example to trigger logic groups.

For integration into the REST API, the endpoints are represented as data points in the LOGIKEDITOR. This allows HTTP requests to be used within logic groups in a similar way to other data points and linked to logic elements.

Before an HTTP request can be processed by the device, the required REST endpoints must first be created and configured.

The REST data points are created and managed in the LOGIKEDITOR under the following menu path:

System > Data Points > Internal + REST

Within a logic group, Internal + REST data points can generally be used like other data points and linked to the inputs and outputs of logic elements.

Structure of the REST API Address

The following components are fixed for accessing the REST API:

1. The HTTPS port is always 444.

2. The predefined path to the REST API is /le/rest.

This results in the following basic structure for an HTTPS request:

https://<IP-ADDRESS>:444/le/rest/<CUSTOM-PART>

The custom part of the URL is determined by the respective configured REST endpoint.

///