Application Programming Interface

Was ist eine API?

Eine API ist eine Schnittstelle, über die unterschiedliche Systeme, Anwendungen und Dienste miteinander kommunizieren können. APIs sind heutzutage allgegenwärtig. In diesem Beitrag erklären wir, wie APIs funktionieren und warum sie so wichtig sind. Außerdem stellen wir die gängigsten Arten von APIs vor und nennen Beispiele aus der Produktion.

Autor Fachredaktion inray Industriesoftware GmbH
Lesezeit 8 Min.

Definition

Was bedeutet API?

Eine API (Application Programming Interface, deutsch Programmierschnittstelle) ist eine festgelegte Schnittstelle, über die zwei Softwaresysteme Daten austauschen und Funktionen des jeweils anderen aufrufen.

Die Bezeichnung API steht für „Application Programming Interface“, auf Deutsch „Programmierschnittstelle“.

Dabei handelt es sich um eine Sammlung an Definitionen, Befehlen und Protokollen, welche die Interaktionsmöglichkeiten mit einem System, einer Anwendung oder einem Dienst festlegen.

Über eine API können zwei unabhängige Softwarekomponenten auf eine vordefinierte Weise miteinander kommunizieren und Daten (in Echtzeit) austauschen. Dadurch, dass der Datenaustausch nur über eine festgelegte Schnittstelle erfolgt, können die restlichen Programmteile verborgen bleiben, was die Kommunikation zwischen Anwendungen deutlich vereinfacht.

APIs kommen in verschiedensten Bereichen zum Einsatz: So sorgen z. B. die Programmierschnittstellen von Betriebssystemen wie Windows dafür, dass Programme für diese Systeme entwickelt und ausgeführt werden können. Ein ERP-System kann über seine API Aufträge und Stammdaten an andere Anwendungen in der Produktion übergeben. Und auch Bestandteile komplexer Software-Systeme kommunizieren untereinander über APIs.

Ist jede Schnittstelle eine API? Nein. Jede API ist eine Schnittstelle, aber nicht jede Schnittstelle ist eine API: Hardwareschnittstellen wie USB oder RS485 verbinden Geräte physisch, eine API regelt dagegen den Austausch zwischen Software. Im Sprachgebrauch heißt eine API deshalb oft auch „API-Schnittstelle“.

Funktionsweise

Wie funktionieren APIs?

Ablauf einer API-Anfrage: Ein Dashboard sendet eine GET-Anfrage mit API-Schlüssel an den Endpunkt einer REST API, der Server prüft den Schlüssel, verarbeitet die Anfrage und antwortet mit Statuscode 200 und JSON-Daten zu Zustand, Stückzahl und Ausschuss einer Presse

APIs können auf verschiedenste Arten implementiert werden (siehe Arten von APIs). Unabhängig von der Implementierung folgen sie jedoch in der Regel einem grundlegenden Funktionsprinzip:

  • API-Anfragen durch einen Client
  • Beantwortung von Anfragen
  • Authentifizierung und Autorisierung
  • API-Dokumentation

API-Anfragen durch einen Client: Die Kommunikation über APIs baut in der Regel auf einem Client-Server-Modell auf, bei dem eine Client-Anwendung API-Anfragen an einen Server stellt und von diesem eine Antwort erhält. Dabei nutzt der Client die von der API vorgegebenen Befehle, Parameter und Endpunkte, um beispielsweise bestimmte Informationen abzurufen oder zu ändern.

Beantwortung von Anfragen: Nach der Verarbeitung der Anfrage generiert der Server eine Antwort, die an den Client zurückgesendet wird. Diese Antwort enthält in der Regel entweder die angeforderten Daten oder Informationen über das Ergebnis einer ausgeführten Operation. Daten werden dabei häufig im JSON- oder XML-Format übertragen.

Die Grafik zeigt diesen Ablauf am Beispiel eines Dashboards, das über eine REST API den Zustand einer Maschine abfragt.

Ablauf einer API-Anfrage: Ein Dashboard sendet eine GET-Anfrage mit API-Schlüssel an den Endpunkt einer REST API, der Server prüft den Schlüssel, verarbeitet die Anfrage und antwortet mit Statuscode 200 und JSON-Daten zu Zustand, Stückzahl und Ausschuss einer Presse

Authentifizierung und Autorisierung: APIs können Sicherheitsmechanismen wie Authentifizierungstoken oder API-Schlüssel verwenden, um sicherzustellen, dass nur autorisierte Anwendungen auf ihre Funktionen zugreifen können.

API-Dokumentation: Eine gute API wird in der Regel zusammen mit einer detaillierten Dokumentation bereitgestellt, die Entwicklern hilft, sie zu verstehen und richtig zu verwenden. Diese Dokumentation enthält z. B. Informationen über verfügbare Endpunkte, unterstützte Anfragemethoden, Parameter, erwartete Antwortformate und mögliche Fehlercodes.

HTTP-Methoden und Statuscodes: Bei webbasierten APIs (Web-APIs) legt die HTTP-Methode fest, was mit einer Ressource geschieht: GET liest Daten, POST legt einen Datensatz an, PUT ändert ihn und DELETE löscht ihn. Diese vier Grundoperationen sind auch als CRUD bekannt. Ein Statuscode in der Antwort zeigt, ob die Anfrage erfolgreich war (z. B. 200 OK) oder warum sie gescheitert ist (z. B. 401 bei fehlender Berechtigung, 404 bei einem unbekannten Endpunkt).

Unterscheidung

Arten von APIs

APIs können nach verschiedenen Kriterien unterschieden werden. Eines davon ist ihre Zugänglichkeit. Zahlreiche APIs sind nur für die interne Kommunikation (Private APIs) gedacht – innerhalb eines Unternehmens oder sogar nur innerhalb eines mehr oder weniger komplexen Software-Systems.

Andere APIs sind öffentlich zugänglich (Public APIs) und zum Teil gut dokumentiert. Außerdem gibt es Hybridmodelle – z. B. APIs, die nur Kunden, Geschäftspartnern oder anderweitig autorisierten Personen zur Verfügung gestellt werden. Sie heißen auch Partner-APIs.

Zugänglichkeit

Private, Partner- und Public APIs im Vergleich

Wer eine API nutzen darf, bestimmt, wie Unternehmen sie dokumentieren und absichern. In der Produktion kommen alle drei Arten vor:

Private, Partner- und Public APIs im Vergleich
Kriterium Private API Partner-API Public API
Zugriff Nur intern, innerhalb eines Unternehmens oder Software-Systems Ausgewählte Kunden, Lieferanten und Geschäftspartner nach Freigabe Öffentlich, meist nach Registrierung mit API-Schlüssel
Typische Nutzer Eigene Entwickler und Anwendungen Entwickler und Systeme der Partnerunternehmen Beliebige Entwickler und Anwendungen
Dokumentation Intern, oft knapp gehalten Für die Partner bereitgestellt Öffentlich und meist ausführlich
Beispiel in der Produktion Das MES liest Fertigungsaufträge aus dem eigenen ERP-System Ein Zulieferer meldet Liefertermine direkt an das Werk des Kunden Ein Online-Dienst liefert Energiepreise oder Wetterdaten

REST, SOAP, RPC und GraphQL

Darüber hinaus ist eine Unterscheidung von APIs nach ihrem Architekturstil und den bei der Implementierung verwendeten Protokollen möglich. Zu den bekanntesten API-Typen gehören die folgenden:

REST

Representational State Transfer (REST) ist heute der führende Architekturstil beim Design von webbasierten APIs. Er basiert auf einem Client-Server-Modell, wobei der Client bestimmte Ressourcen mithilfe des HTTP-Protokolls adressiert. REST definiert verschiedene Kriterien, die eine sogenannte RESTful API erfüllen muss, darunter insbesondere die Zustandslosigkeit.
Was ist REST?

SOAP

SOAP ist ein Netzwerkprotokoll für den Datenaustausch zwischen Systemen. Auch SOAP definiert einen Ansatz für den Aufbau einer API und beschreibt, wie Daten ausgetauscht, verpackt und gesichert werden. Bei der Datenübertragung können Protokolle wie HTTP, SMTP oder FTP verwendet werden, Daten werden dagegen im XML-Format repräsentiert.

RPC

RPC steht für Remote Procedure Call. Eine RPC-API stellt Funktionen zur Verfügung, die durch einen Client auf entfernten Systemen aufgerufen werden können. Dieser Ansatz kommt hauptsächlich bei privaten APIs zum Einsatz. Daten können u. a. in den Formaten XML (XML-RPC) und JSON (JSON-RPC) repräsentiert werden.

GraphQL

GraphQL ist eine Abfragesprache und Laufzeitumgebung für APIs, die komplexere Anfragen unterstützt. Clients können gezielt mehrere Ressourcen in einer Anfrage adressieren. Außerdem können sie als Abonnenten auftreten und bei Datenänderungen in Echtzeit benachrichtigt werden.

Produktionsdaten optimal nutzen

manubes

Mit manubes visualisieren, überwachen und steuern Sie Ihre Produktion über eine zentrale Weboberfläche – überall und auf jedem Endgerät.

Neben industriellen Standardprotokollen wie OPC UA und MQTT nutzt manubes auch REST, um mit Online-Diensten, Geräten und anderen Anwendungen zu kommunizieren. Anfragen an REST-APIs können dabei in automatisierte Workflows integriert werden, wodurch sich der industrielle Datenaustausch gezielt steuern lässt.

Jetzt testen→
manubes

Warum sind APIs so wichtig?

Bei der Entwicklung von Software, der Bereitstellung von Webdiensten und der Kommunikation zwischen Anwendungen sind APIs heutzutage unverzichtbar. Die wichtigsten Vorteile der API-Nutzung lassen sich folgendermaßen zusammenfassen:

Interoperabilität

APIs ermöglichen es verschiedenen Anwendungen und Systemen, nahtlos miteinander zu interagieren, unabhängig von ihrer zugrunde liegenden Implementierung oder Programmiersprache.

Modularität und Wiederverwendbarkeit

Durch die Verwendung von APIs können Entwickler auf bereits vorhandene Funktionen und Dienste zugreifen, anstatt sie selbst neu implementieren zu müssen. Komplexere Anwendungen können dadurch zunehmend aus einzelnen Diensten aufgebaut werden. Das erleichtert nicht nur die Wartung und Fehlerbehebung, sondern sorgt auch für eine bessere Skalierbarkeit.

Ökosysteme und Partnerschaften

APIs spielen eine Schlüsselrolle bei der Schaffung von Ökosystemen und Partnerschaften zwischen Unternehmen, Geschäftspartnern, Kunden und anderen Parteien. Indem Unternehmen Drittanbietern oder unabhängigen Entwicklern Zugriff auf bestimmte Ressourcen gewähren, können sie zudem ohne hohe Kosten die Reichweite und den Funktionsumfang ihrer Produkte und Dienstleistungen erweitern.

Beschleunigte Entwicklung und Markteinführung

Indem sie Programmierern Zugang zu vorgefertigten Funktionen und Diensten bieten, beschleunigen APIs die Entwicklung von Softwareanwendungen erheblich.

Industrie

APIs in der Produktion

APIs in der Produktion: Maschinen per OPC UA, Sensoren per MQTT und Datenbanken per SQL sind über einen Edge Node mit manubes verbunden; manubes ruft die REST APIs von ERP-System, KI-Dienst und Energiepreis-Dienst auf und stellt frei projektierte REST-Zugriffe als eigene API zur Produktion für BI-Werkzeuge und ein Kundenportal bereit

In der Produktion verbinden APIs Maschinen, Unternehmenssoftware und Cloud-Dienste. Dabei treffen zwei Welten aufeinander: Maschinen und Steuerungen kommunizieren meist über Industrieprotokolle wie OPC UA oder MQTT, während Unternehmenssoftware wie ERP und MES sowie Online-Dienste ihre Daten und Funktionen über REST APIs bereitstellen. Seit Version 1.05.04 bringt auch OPC UA mit der OPC UA Web API eine REST-kompatible Schnittstelle mit. Wann sich welches Protokoll eignet, zeigt der Vergleich MQTT vs. REST vs. OPC UA.

Integration statt Insellösungen: Die Integration über APIs ermöglicht es Unternehmen, ihre Systeme zu verbinden, ohne Daten von Hand zu übertragen. Typische Anwendungsfälle sind Auftragsdaten aus dem ERP-System im Shopfloor-Dashboard, Kennzahlen aus der Fertigung im Reporting oder Messdaten, die ein KI-Dienst bewertet.

manubes verbindet beide Welten: Die Plattform läuft in der Cloud, bindet Maschinen über einen Edge Node im Produktionsnetz an und bringt Connectoren für OPC UA Server, MQTT Broker, REST APIs und Datenbanksysteme mit. Anfragen an die REST APIs anderer Systeme lassen sich in automatisierte Workflows einbinden, die im Workflow Designer entstehen – etwa um PV-Anlagendaten per ChatGPT-API zu bewerten.

Eigene API zur Produktion: Umgekehrt erlaubt manubes frei projektierbare REST-Zugriffe. Damit gestalten Unternehmen ihre eigene API zur Produktion und legen selbst fest, welche Daten und Funktionen für andere Anwendungen sichtbar sind – zum Beispiel offene Aufträge für ein Kundenportal oder Kennzahlen für ein BI-Werkzeug.

APIs in der Produktion: Maschinen per OPC UA, Sensoren per MQTT und Datenbanken per SQL sind über einen Edge Node mit manubes verbunden; manubes ruft die REST APIs von ERP-System, KI-Dienst und Energiepreis-Dienst auf und stellt frei projektierte REST-Zugriffe als eigene API zur Produktion für BI-Werkzeuge und ein Kundenportal bereit

Eigene API zur Produktion mit manubes

Maschinen per OPC UA und MQTT anbinden, ERP-Systeme und Online-Dienste per REST einbinden und eigene REST-Zugriffe auf Ihre Produktionsdaten projektieren.

Jetzt testen

Worauf es bei der API-Sicherheit ankommt

Eine API öffnet ein System für andere Anwendungen. Gerade in der Produktion, wo Stillstände teuer sind, gehört die API-Sicherheit deshalb von Anfang an zu den Anforderungen jeder Integration. Diese Punkte sollten Unternehmen beachten:

Authentifizierung

Jede Anfrage muss sich ausweisen, etwa mit einem API-Schlüssel oder einem Token. API-Schlüssel gehören nicht in Quellcode oder E-Mails, sondern in eine geschützte Konfiguration, und werden regelmäßig erneuert.

Verschlüsselte Übertragung

APIs sollten nur über HTTPS (TLS) erreichbar sein, damit Daten und Zugangsschlüssel unterwegs weder mitgelesen noch verändert werden können.

Berechtigungen nach dem Minimalprinzip

Jede Anwendung erhält nur die Rechte, die sie braucht. Ein Reporting-Werkzeug darf Kennzahlen lesen, aber keine Aufträge ändern.

Begrenzung und Protokollierung

Ein Limit für Anfragen pro Zeitraum (Rate Limiting) schützt vor Überlastung, ein Protokoll zeigt, wer wann worauf zugegriffen hat. Ein API-Gateway kann beides zentral übernehmen.

Produktionsnetz geschlossen halten

Maschinen und Steuerungen sollten nicht direkt aus dem Internet erreichbar sein. Sicherer ist eine Anbindung, bei der Daten nur ausgehend aus dem Produktionsnetz übertragen werden – mehr dazu im Beitrag Produktion sicher an die Cloud anbinden.

Beispiele

5 Praxisbeispiele für APIs

Von der Maschine über die Unternehmenssoftware bis hin zu Cloud-Diensten – APIs spielen eine entscheidende Rolle in der Vernetzung und Interaktion zwischen verschiedensten Anwendungen und Systemen der Industrie 4.0.

Zur Veranschaulichung betrachten wir typische Beispiele für APIs in der Produktion.

Auftragsdaten aus dem ERP-System

Das ERP-System stellt offene Fertigungsaufträge über eine REST API bereit. Ein Shopfloor-Dashboard ruft sie ab und zeigt der Schichtleitung, welcher Auftrag als Nächstes an welcher Linie läuft.

Industrielle Anlagen

Industrielle Maschinen und Geräte können über APIs nicht nur Echtzeitdaten bereitstellen, sondern auch Steuerungsanweisungen und Parameter empfangen. Mit unserer Cloud-Plattform manubes lassen sich solche API-Anfragen in Form von Workflows automatisieren.

Sendungsverfolgung im Versand

Versanddienstleister wie DHL bieten APIs zur Sendungsverfolgung an. Die Versandabteilung übernimmt den Status ausgehender Lieferungen automatisch, statt ihn auf Webseiten nachzuschlagen.
API-Katalog von DHL (Öffnet in neuem Fenster)

Energiepreise im Energiemonitoring

Online-Dienste liefern aktuelle Strompreise oder Wetterdaten per API. Im Energiemonitoring zeigen sie, wann energieintensive Prozesse am günstigsten laufen.
Energiemonitoring

Messdaten per KI bewerten

Ein Workflow sendet Anlagendaten an die API eines KI-Dienstes und erhält eine Bewertung zurück – so wie bei der automatisierten Leistungsbewertung von PV-Anlagen per ChatGPT-API.

Häufige Fragen zu APIs

Was bedeutet API auf Deutsch?

API steht für Application Programming Interface, auf Deutsch Programmierschnittstelle oder Anwendungsprogrammierschnittstelle. Gemeint ist eine festgelegte Schnittstelle, über die zwei Softwaresysteme Daten austauschen und Funktionen des jeweils anderen aufrufen – zum Beispiel ein Dashboard, das Auftragsdaten aus dem ERP-System abruft.

Ist eine API dasselbe wie eine Schnittstelle?

Nicht ganz: Jede API ist eine Schnittstelle, aber nicht jede Schnittstelle ist eine API. Eine API regelt den Austausch zwischen Software über festgelegte Befehle, Endpunkte und Datenformate. Hardwareschnittstellen wie USB oder RS485 verbinden dagegen Geräte physisch. Umgangssprachlich heißt eine API oft auch „API-Schnittstelle“.

Was kann man mit einer API machen?

Mit einer API rufen Anwendungen Daten aus anderen Systemen ab, legen dort Datensätze an, ändern sie oder lösen Funktionen aus, ohne dass jemand Daten von Hand überträgt. Das ermöglicht die Integration von Software und Cloud-Diensten. In der Produktion holt eine API zum Beispiel Aufträge aus dem ERP-System, übergibt Kennzahlen an das Reporting oder schickt Messdaten zur Bewertung an einen KI-Dienst.

Was ist ein API-Schlüssel?

Ein API-Schlüssel (englisch API Key) ist eine geheime Zeichenfolge, mit der sich eine Anwendung bei einer API ausweist. Die API prüft den Schlüssel bei jeder Anfrage und lässt nur berechtigte Anwendungen zu. API-Schlüssel sind wie Passwörter zu behandeln: geschützt speichern, nicht weitergeben und regelmäßig erneuern.

Was ist der Unterschied zwischen einer API und einer REST API?

API ist der Oberbegriff für jede Programmierschnittstelle. Eine REST API ist eine API, die dem Architekturstil REST folgt: Sie adressiert Ressourcen über URLs, nutzt HTTP-Methoden wie GET und POST und arbeitet zustandslos. REST ist heute der führende Stil für webbasierte APIs.

Was ist der Unterschied zwischen API und Webhook?

Bei einer API fragt der Client aktiv nach Daten, wenn er sie braucht. Bei einem Webhook ist es umgekehrt: Das sendende System ruft bei einem Ereignis selbst eine vorher hinterlegte URL auf und liefert die Daten mit. Webhooks eignen sich für Benachrichtigungen über Ereignisse, APIs für gezielte Abfragen und Änderungen.

Wie werden APIs in der Produktion genutzt?

In der Produktion verbinden APIs Maschinen, Unternehmenssoftware und Cloud-Dienste. Maschinen liefern ihre Daten meist über OPC UA oder MQTT, ERP-Systeme und Online-Dienste über REST APIs. Eine Plattform wie manubes führt beides zusammen, automatisiert API-Anfragen in Workflows und stellt über frei projektierbare REST-Zugriffe eine eigene API zur Produktion bereit.

Produktvideo: Lernen Sie manubes kennen

Testen Sie manubes – kostenlos und unverbindlich

Testen Sie sämtliche manubes-Features in Ihrer persönlichen Cloud-Umgebung.

Testzugang erhalten