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!

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.

Illustration Atlassian Enterprise
Produkt

Atlassian-Produkte

Die gesamte Produktpalette von Atlassian ist darauf ausgerichtet, die Arbeit von Projekt-Teams zu optimieren.

Cloud Software
Lösung

Cloud-Produkte

Unsere Produkte und Solutions auf einen Blick

Event

KI basierte Kundenbetreuung für Versicherer

Im Webinar erfahren Sie, wie moderne Kundenbetreuung in der digitalisierten Welt aussieht. Watson Assistent hilft bei der Optimierung bestehender Lösungen. Dieser virtuelle KI-Assistent liefert Kunden schnelle, konsistente und akkurate Antworten über alle Kommunikations-Kanäle, -Plattformen, -Applikationen und Geräte hinweg.

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?

Anonyme Referenz
Referenz

Produkt-Echtzeitanalyse bei Maschinenbauunternehmen

Ein deutsches Maschninenbauunternehmen ermöglicht mit Hilfe von X-INTEGRATE und Industrie 4.0 Technologie ihren Kunden, den Status jedes Geräts visuell und in Echtzeit zu überwachen und auf dieser Basis Arbeitsabläufe zu steuern.

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.

Cloud Technologie Managed Service
Produkt

Apigee - API Management

API Management mit Google Cloud simplifizieren. Das Bauen, Sichern, Veröffentlichen, Überwachen und Skalieren der eigenen APIs wird zentral auf Apigee geregelt. Jetzt Termin vereinbaren!

Produkt

Atlassian-Produkte & catworkx-Apps

Atlassian-Produkte (z.B Jira & Confluence) unterstützen Teams optimal bei der Zusammenarbeit. Ergänzend dazu bieten unsere hauseigenen Apps spezifische Funktionalitäten oder Integrationen.

Technologie Übersicht

Beratung rund um IBM Produkte

Als IBM Platinum Business Partner sind wir für Sie da. Ob Beratung, Begleitung oder Umsetzung – mit dem gesamten Portfolio der IBM finden wir die optimale Lösung für Sie.

Technologie Übersicht

Beratung rund um IBM Produkte

Als IBM Platinum Business Partner sind wir für Sie da. Ob Beratung, Begleitung oder Umsetzung – mit dem gesamten Portfolio der IBM finden wir die optimale Lösung für Sie.

Referenz

Galuba & Tofote: KI-basierte Marktanalyse-Lösung swarmsoft

Ein ARS Team aus den Bereichen Softwareentwicklung und Künstliche Intelligenz unterstützte die Galuba & Tofote Consulting PartG bei der Entwicklung der KI-basierten Marktanalyselösung swarmsoft®

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

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

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 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.

Event

Next-Gen API Management

Erleben Sie, wie nahtlose Integration wirklich funktioniert- mit praxisnahen Lösungen, echten Hands-on-Demos und Networking mit Expert*innen in der IBM Zürich.

Whitepaper

Whitepaper: Eine Einführung ins API Management

Was genau sind APIs, welche Use Cases gibt es und wie können sie unterschiedliche Geschäftsziele unterstützen? Erfahren Sie in unserem kostenlosem Whitepaper.

Wissen

REST-API und andere kleine Helferlein

Der Sterling Integrator wird in vielen Unternehmen zusammen mit dem Sterling File Gateway als zentrale Schnittstelle und Datendrehscheibe eingesetzt. In diesem Artikel erhalten Sie ein Update-Review zu Sterling B2B Integrator 5.2.6.2 und Filegateway 2.2.6.2.

In die Google Cloud Workspace
Referenz

woom: Die zentrale Lösung für ihre Office-Produkte

Woom produziert Fahrräder, die auf Kinder zugeschnitten sind. Von ergonomischen Sitzmöglichkeiten, bis hin zu kleineren Bremsen, haben sie alles für ein schönes Erlebnis durchdacht.

Bleiben Sie mit dem TIMETOACT GROUP Newsletter auf dem Laufenden!