Scheer PAS API Management

Das API-Management von Scheer PAS bietet Ihnen bei der Verwaltung und Optimierung Ihrer Programmierschnittstellen ein Maximum an Kontrolle.

Es gibt unterschiedliche Berechtigungsstufen für die Nutzung und Verwaltung der APIs, Services und Clients. Die Bereitstellung und Veröffentlichung von Verträgen (Contracts) wird flexibel und in Echtzeit gesteuert. Der Zugriff auf die Schnittstellen ist sowohl über (unveränderliche) Contracts als auch über die Nutzung von öffentlichen APIs möglich. Die Dokumentation Ihrer APIs ist über deren vollständigen Lebenszyklus mithilfe von Swagger (OpenAPI-Specification) sichergestellt.

Mit Scheer PAS sind alle angebundenen REST und SOAP Schnittstellen über das API-Management abgesichert. Darüber hinaus lassen sich auch die REST und SOAP Schnittstellen anderer Systeme verwalten. Die Verwendung der einzelnen APIs können Sie nun Ihren Entwicklern, Partnern sowie Endkunden flexibel anbieten. Scheer PAS API Management ermöglicht den direkten Import von xUML Service Endpoints in das API-Management.

Policies (Regeln) machen Ihr API Management agil. Sie bieten die Möglichkeit, das Verhalten einer Schnittstelle sehr schnell und einfach anzupassen. Policies sind eine Abfolge von unterschiedlichen Statements, die sequentiell an verschiedenen Stellen (API, Plan, Client) angewendet und flexibel angepasst werden können.

Ablauf des API-Managements
mit Scheer PAS

Die Bereitstellung einer Programmierschnittstelle erfolgt in mehreren Schritten. Zunächst muss das API ausgewählt bzw. neu angelegt werden. Daraufhin werden ein oder mehrere Pläne, bestehend aus einer Gruppe von Policies definiert. Danach wird ein Benutzer der API (Kunde) und die Definition eines Vertrages erstellt. Der Vertrag verknüpft einen bestimmten Plan mit einer API. Pro Kunde können beliebig viele Verträge angelegt werden.

Für die Verwaltung einer großen Anzahl von Schnittstellen müssen APIs, Pläne und Kunden in Gruppen, genannt Organisationen, eingeteilt werden. Die Nutzer innerhalb einer Organisation erhalten Berechtigungen in Form von Rollen. Zum Beispiel darf ein Benutzer mit der Rolle „API-Viewer“ alle APIs einer Organisation sehen, aber nicht editieren.

Was ist API-Management?

Das API-Management bietet die Möglichkeit verschiedene Programmierschnittstellen auch APIs (Application Programming Interfaces) genannt, zentral zu verwalten. Das API-Management dient, neben der Verwaltung, insbesondere der Kontrolle und Bereitstellung der Schnittstellen. So werden die APIs meist katalogisiert, versioniert, dokumentiert und letztendlich intern oder extern veröffentlicht. Der hierbei erstellte Katalog beinhaltet eine Übersicht zu allen verfügbaren Schnittstellen.

Die Veröffentlichung der jeweiligen API erfolgt über Gateways. Ein Gateway ist der eigentlichen Implementierung im Backend vorgelagert und dient als zentrale Sammelstelle für Anfragen (Requests).

Wie laufen API-Management Projekte ab?

Projekte im API-Management gestalten sich sehr individuell und richten sich immer nach dem derzeitigen Bedürfnis des jeweiligen Unternehmens. Es gibt allerdings bestimmte Szenarien, die im Business Kontext häufig vorkommen. Diese Anwendungsfälle werden im Folgenden skizziert.

Szenario A
Eine Schnittstelle soll zwei Partnern angeboten werden

Der erste Schritt ist die klare Definition der Schnittstelle. Für den ersten Partner wird dann zum Beispiel ein Vertrag mit 10.000 Zugriffen pro Tag angelegt. Der zweite Partner bekommt einen Vertrag mit 100.000 Zugriffen pro Tag. Die Aufgabe des API-Managements liegt in diesem Fall in der Überwachung der Schnittstellen und der Protokollierung der Zugriffe, um am Ende des Monats eine Abrechnung zu erstellen.

Szenario B
Eine Schnittstelle wird von mehreren mobilen Apps genutzt

Das Problem von mobilen Applikationen: es werden sehr viele Daten übertragen. Damit das Gesamtsystem nicht überlastet wird, ist also ein Datenlimit notwendig. Durch die Schnittstellen-verwaltung kann für jede mobile App ein Kunde angelegt werden, dem dann anschließend ein Datenlimit zugewiesen werden.

Szenario C
Transparenz

im Unternehmen

In einer großen Organisation gibt es für beliebte Schnittstellen viele Verwender. Bei Änderungen der API ist es wichtig zu wissen, wer die Schnittstelle aktuell wie intensiv verwendet. Dies ist wichtig, da der Umstellungsaufwand so im Voraus geplant werden kann. Von Vorteil ist es dabei, wenn jeder interne Nutzer als Kunde im API-Management erfasst wird. So kann bei jedem Aufruf die eindeutige Kennung des Nutzers (API-Key oder auch Schlüssel genannt) übermittelt werden. Das Unternehmen behält so stets die Übersicht und Kontrolle über die Nutzung.

Warum ist API-Management sinnvoll?

Moderne Schnittstellen-Management Systeme verbessern insbesondere die Agilität und Sicherheit der Unternehmens-IT. So lassen sich verschiedene Versionen einer Programmierschnittstelle zentral sichern und verwalten. Es können aber auch viele unterschiedliche APIs über eine bestimmte URL angeboten werden. Bei Bedarf kann auch eine öffentliche oder private API erstellt werden. Die Benutzerzugriffe können dadurch explizit gesteuert und verwaltet werden.

Vorteile des API-Managements

  • Zentralisierte Sicherheit: durch automatisch angewandte Richtlinien und eine zentralisierte Nutzer-, Zugriffs- und Authentifizierungsverwaltung
  • Versionsverwaltung: durch Versionierung von APIs und Clients
  • Skalierbarkeit: durch den Einsatz von mehreren und spezialisierten Gateways
  • Caching: Reduzierung der Last im Backend: durch Caching von datenintensiven Anfragen oder sich selten ändernden Daten
  • Optimierung: Leistungsoptimierung: durch gezielte Anpassungen basierend auf Metriken und Zugriffskontrollen
  • Überwachung des Datenverkehrs einzelner Clienten und APIs
  • Vereinfachte Abrechnung
  • Quota-Limits: Beschränkung der Anzahl an Requests an die Schnittstelle.
  • Rate-Limits: Beschränkung der Anzahl an Requests zur Vermeidung einer Backend Überlastung. Beispielsweise maximal 100 Requests pro Minute für die Vermeidung von Denial of Service Attacken (DOS)
  • Zeitgesteuerte Verfügbarkeit: frei konfigurierbare Zeiträume in denen APIs verfügbar beziehungsweise nicht verfügbar sind
  • Traffic-Beschränkungen: Beschränkung des verfügbaren Datenvolumens pro API oder einzelnem Client