Lesezeit: 2 Minuten

Die vielfältigen Bestandteile API-basierter Produkte


Denken wir als IT-Experten an APIs und API-Produkte, kommen uns oft die technischen APIs der Umgebungen und Systeme in den Sinn, mit denen wir viel Erfahrung gesammelt haben. Damit sich eine technische API zu einem wertvollen Produkt entwickeln kann, braucht es aber die Ergänzung um gänzlich andere Bestandteile.

Technische Webservices

Eine API besteht natürlich aus einem technischen System, das eine Geschäftsfähigkeit kapselt und zum Beispiel über REST, SOAP oder andere technische Schnittstellen zugänglich macht. Aber auch asynchrone Protokolle, wie z.B. Websockets oder PubSub Protokolle wie Kafka gehören dazu. Auch diese haben logischerweise API-Charakter. Dieser Teil unserer API wird auch (Web)Service genannt.

API Design – Dokumentation und Spezifikation

Zusätzlich zu diesem technischen Teil des Systems benötigen wir in der Regel auch einen Beipackzettel für die Partner und Kollegen, die sich mit diesem technischen Dienst integrieren wollen. In dieser sogenannten API-Dokumentation bzw. dem API Design Dokument wird Folgendes beschrieben:

  • Auflistung der möglichen Operationen
  • Beschreibung von Taxonomien und Datenmodellen
  • Erklärung der fachlichen Auswirkungen der Operationen
  • Technische Spezifikation des Zugriffs (z.B. inkl. Zugriffskonzept)

Vereinbarungen und Spielregeln

Darüber hinaus gibt es auch noch weitere organisatorische Aspekte mit hoher Relevanz, die in der Dokumentation einer API geregelt werden.

  • Wer sind die Ansprechpartner hinter dieser API?
  • Wie kann ich mit diesen bei aufkommenden Fragen und Problemen in Kontakt treten?
  • Welche Vereinbarungen und Zusicherungen seitens des API Providers gelten bei der Verwendung, wie z.B. Limits, Mengengerüste, SLAs und Verfügbarkeiten beim Zugriff, aber auch ggf. Haftungsfragen in Problemsituationen?

Standardisierung der Interaktion mit Hilfe des API Lifecycles

Wie aber kommuniziert der Anbieter einer API mit seinen Konsumenten? Hierfür hat sich ein Interaktionsmodell herauskristallisiert - der sogenannte API Lifecycle. Der API Lifecycle liefert standardisierte Antworten auf folgende Fragestellungen:

  • Wie lange kann ich versichern, dass eine API-Version nutzbar ist?
  • Wie veröffentliche ich Fehlerbehebungen oder zusätzliche Features, ohne die laufende Interaktion mit Konsumenten zu stören?
  • Wie verhält sich ein API Provider Team im Falle von „Breaking Changes“ (=Änderungen der geltenden technischen/organisatorischen Vereinbarungen)?

Also zusammengefasst sind APIs ein Interaktionsmodell, das sogenannten soziotechnischen Systemen (Wertschöpfung bestehend aus dem Zusammenspiel von Mensch und Technik) erlaubt, ihre Zusammenarbeit zu standardisieren, ohne dabei die Unabhängigkeit/Agilität beider Parteien negativ zu beinträchtigen. APIs bieten bei richtiger Anwendung die Möglichkeit, widerstandsfähige und stabile Integrationen zu ermöglichen.

Tipp für den Einstieg: Gutes Design für den langfristigen Erfolg von API-Produkten

Was vermeintlich einfach klingt, ist in der Praxis die erste große Herausforderung. Ein geschickt gestaltetes und inhaltlich vollständiges API Design reduziert die Einstiegshürden und damit auch die Entwicklungskosten auf Seiten der API Konsumenten. Aber nicht nur auf Seiten der API Konsumenten bringt es Vorteile, sich hier auf Erfahrungswerte und Best-Practices zu stützen. Ein guter, fachlich versierter Schnitt der APIs, aber auch die Wahl der richtigen Design-Patterns, reduziert die Wahrscheinlichkeit von Breaking Changes und damit auch die Kommunikationsaufwände beim API-Anbieter.

Blogautor

Dietmar Rager
Chief Technology Officer (CTO) ARS Computer und Consulting GmbH
Ihr Erfolg ist unser Ziel

Stehen Sie vor komplexen IT-Projekten? Mit unserer Expertise bieten wir Ihnen maßgeschneiderte Lösungen. Erfahren Sie mehr.

Werde Teil unseres Teams

Wir suchen ständig nach neuen Talenten. Für dich haben wir genau die richtige Stelle. Schau dir unsere offenen Positionen an.

Noch Fragen? Wir helfen Ihnen gerne!

Blog 12.12.24

API-Dokumentation jenseits der Bestandsaufnahme

API-Dokumentation ist kein Luxus, sondern essenziell für fehlerfreie Prozesse. Erfahren Sie, warum OpenAPI oft nicht reicht und wie Sie mit Spring REST-Docs prozessgetriebene, getestete und aktuelle API-Dokumentation erstellen.

Blog 28.04.23

Bestandteile und Dienste einer API Plattform

Grundlegende Erläuterungen zu API (Lifecycle) Management, durchdachtes API Design und den Sinn hinter API-Management

Kompetenz 29.07.21

API Economy & API Management

Eine beschleunigte und sichere Bereitstellung von Daten und Services eröffnet neue Geschäftsmodelle z.B. im Kontext B2B, B2C. Daneben sind interne API Ökosysteme" im Kontext von Cloud- native Architekturen, Microservices, Internet of Things und Mobile Use Cases nicht mehr Wegzudenken.

Blog 22.12.22

Teil 5 - Einfluss von Cloud-native auf die Architekturarbeit

Wir beleuchten technische Aspekte von cloud-native Architekturen, die Vorteile verteilter Systeme und wie wichtig API-Management-System ist.

Blog 11.11.24

API Maturity: Wie reif sind unsere Schnittstellen?

API-Reife: Wie fit sind Ihre Schnittstellen für die Digitalisierung? Erfahren Sie, wie API-Reifegradmodelle Integration, Skalierbarkeit und Effizienz in Ihrem Unternehmen fördern können.

Blog 19.02.25

Unterschätzte Vielschichtigkeit – API-Management

APIs sind das Rückgrat der digitalen Transformation, doch ihr Management geht weit über Entwicklung hinaus. Von Governance und Sicherheit bis hin zur Qualitätssicherung – eine durchdachte API-Strategie ist essenziell. Erfahre in unserem Blog, wie Unternehmen ihre API-Landschaft effizient verwalten und optimieren können.

Blog 16.03.23

Bedeutung von APIs als Interaktionsmodell

APIs sind mehr als Schnittstellen, sie sind Teil der Interaktion zwischen Geschäftspartnern. Eine API First Strategie soll vor allem Wertschöpfung schaffen

Blog 25.05.23

Roadmap zu digitalen Produkten

Was ist bei der Skalierung von API-Initiativen zu beachten? Wie werden durch zentrale Verwaltung und Veröffentlichung von APIs diese Daten und Dienste zugänglich?

Leistung 27.04.23

API Management Plattform - Apigee | Google Cloud

Apigee ist eine coole Plattform für die Verwaltung von APIs. Damit können Unternehmen APIs erstellen, schützen, veröffentlichen und analysieren.

Referenz

Erfolgreiche Einführung organisationsweiter API-Landschaften

ARS unterstützte die Automotive-Software-Tochter eines führenden deutschen Automobilherstellers erfolgreich bei der Einführung und Pflege organisationsweiter API-Landschaften.

Blog 30.03.23

Eine API kommt selten allein - APIs in der freien Wildbahn

API's als Produkt zu verstehen ist ein Merkmal agiler Arbeitsweise. API's sind immer im Kontext des geplanten Services und des Ökosystems zu betrachten.

Blog 10.10.24

DevOps? Warum APIOps der nächste logische Schritt ist

APIOps erweitert DevOps-Praktiken auf APIs, um deren Entwicklung zu automatisieren und zu optimieren. Dieser Ansatz verbessert Qualität, Sicherheit und Geschwindigkeit im API-Management.

Referenz

API Economy für HUK-COBURG

Mit Definition von API Design Richtlinien wurde für HUK-COBURG der Weg in die API Economy geschaffen. Dabei wurde Erfordernissen nach Automation und Security Enforcement Rechnung getragen

Kompetenz

API Maturity Fragenkatalog

Finden Sie heraus, wo Ihre API-Strategie wirklich steht! Mit unserem API Maturity Fragenkatalog erhalten Sie eine fundierte Bewertung Ihrer API-Landschaft und konkrete Handlungsempfehlungen.

Blog 18.06.20

The Future-Proof Business: API-Management

Die Aufzeichnung des zweiten Teiles unserer gemeinsam mit CROZ und Red Hat gehosteten Webinarreihe, "The Future-Proof Business" ist jetzt zum Nachsehen verfügbar!

Referenz

HUK-COBURG: Mit ARS in 90 Tagen in die API Economy

Durch die Unterstützung von ARS gelang der HUK-COBURG im Rahmen einer zeitkritischen Initiative der Sprung in die API Economy.

Service

API Economy, DevOps, Low Code & MACH

Kundenorientierte Lösungen zu den Themen API Economy, DevOps, Low Code und MACH (Microservices, API-first, Cloud-native und Headless Architecture)

Blog 05.11.24

Strategische Bedeutung von APIs in digitaler Transformation

Erfahren Sie, wie APIs Unternehmen Wettbewerbsvorteile verschaffen und die digitale Transformation beschleunigen. Mit praxisnahen Beispielen und Tipps zur Umsetzung.

Headerbild Talend Application Integration
Technologie

Talend Application Integration / ESB

Mit Talend Application Integration erschaffen Sie eine serviceorientierte Architektur und verbinden, vermitteln & verwalten Ihre Services und APIs in Echtzeit.

Event 26.10.20

Webcast Talend Application Integration

Mit Talend Application Integration erschaffen Sie eine serviceorientierte Architektur und verbinden, vermitteln und verwalten Ihre Services in Echtzeit. Erfahren Sie alles in unserem Webcast!

Bleiben Sie mit dem TIMETOACT GROUP Newsletter auf dem Laufenden!