Komponenten von API Connect

Die API Connect Komponenten bieten eine einheitliche Benutzererfahrung über den gesamten API-Lebenszyklus. Änderungen in einer Phase des API-Lebenszyklus spiegeln sich automatisch in den anderen Komponenten von API Connectwider.

Cloud Manager

Die Komponente API Connect Cloud Manager wird verwendet, um die lokale API Connect -Cloud zu verwalten. Der Cloudadministrator verwendet diese Benutzerschnittstelle zu folgenden Zwecken:
  • Definieren des Clusters von Managementservern, Gateway-Servern und Containern, die in der Cloud erforderlich sind, und Konfigurieren der Topologie. Informationen zu Management-und Gateway-Servern finden Sie unter API Connect -Servervoraussetzungen. Informationen zu Containern finden Sie unter Laufzeit.
  • Verwalten (Ändern, Verschieben, Entfernen, Neustarten, Neubooten) der Server in der Cloud.
  • Überwachen des Status der Cloud.
  • Definieren und Verwalten der Provider-Organisationen, die APIs entwickeln. (Zugeordnete Manager oder Eigner der Provider-Organisationen können diese Task ebenfalls ausführen.)
  • Definieren zusätzlicher Cloudadministratoren oder Konfigurieren von Benutzern mit Rollen, die den Zugriff auf bestimmte Funktionen ermöglichen.
  • Hinzufügen von Benutzerregistrys für das Authentifizieren von Benutzern und Sichern von APIs und Konfigurieren der sicheren Datenübertragung (z. B. über Websites).

Weitere Informationen zu Cloud Managerfinden Sie unter Cloud verwalten.

Developer Toolkit

Das Entwicklertoolkit stellt die Tools zum Modellieren, Entwickeln und Testen von APIs bereit. Das Entwicklertoolkit enthält eine Befehlszeilenschnittstelle (CLI) und eine entsprechende grafische Benutzerschnittstelle, API Designer.

API-Entwickler verwenden die API-Managementfunktionen in API Designer oder die CLI, um API-Entwurfsdefinitionen für REST-und SOAP-APIs oder für OAuth-Provider-Endpunkte zu erstellen, die für die OAuth 2.0 -Authentifizierung verwendet werden. Die API-Definitionen können so konfiguriert werden, dass die API zu einem Produkt hinzugefügt wird, dass ein Richtlinien-Assembly-Datenfluss (zum Manipulieren von Anforderungen/Antworten) hinzugefügt wird, und dass Sicherheitsoptionen und weitere Einstellungen definiert werden. APIs können dann vor der Veröffentlichung lokal getestet werden, um sicherzustellen, dass sie ordnungsgemäß definiert und implementiert wurden.

API-Entwürfe (in den enthaltenen Produkten), die mit API Designeroder über die Befehlszeilenschnittstelle erstellt werden, werden in Katalogen veröffentlicht.

Das Entwicklertoolkit wird lokal für die Offline-API-und Anwendungsentwicklung installiert. Weitere Informationen zum Developer Toolkitfinden Sie unter APIs und Anwendungen entwickeln.

API Manager

API Manager stellt eine Benutzerschnittstelle zur Verfügung, die die Hochstufung und Verfolgung von APIs ermöglicht, die in Produkten und Plänen gepackt sind. API-Provider können die Produkte durch ihren gesamten Lebenszyklus bewegen und die Verfügbarkeit und Sichtbarkeit von APIs und Plänen verwalten.

Kataloge und Bereiche werden in API Manager als Bereitstellungsziele erstellt, über die APIs, Pläne und Produkte in Konsumentenorganisationen veröffentlicht werden. API-Provider können ihre Produkte in Katalogen oder Bereichenbereitstellen und dann veröffentlichen, damit die APIs in diesen Produkten in einem Developer Portal für die externe Erkennung sichtbar werden.

Zur Steuerung des Zugriffs auf die verfügbaren API-Managementfunktionen können Benutzer in der Provider-Organisation in der Benutzerschnittstelle von API Manager mit zugewiesenen Rollen und Berechtigungen eingerichtet werden. API-Provider können die Benutzerschnittstelle auch zum Verwalten der Konsumentenorganisationen verwenden, die sich für den Zugriff auf ihre APIs und Pläne anmelden. Entwickler-Communitys können zusätzlich erstellt werden, um eine Sammlung von Konsumentenorganisationen zu gruppieren, für die eine bestimmte Gruppe von Produkten und Plänen bereitgestellt werden kann.

Die Benutzerschnittstelle von API Manager enthält außerdem Funktionen zum Verwalten der Sicherheit der API-Umgebung und bietet Zugriff auf Analyseinformationen zu API-Aufrufmetriken in anpassbaren Dashboardansichten.

Weitere Informationen zu API Managerfinden Sie unter APIs verwalten.

API-Gateways

Gateways erzwingen Laufzeitrichtlinien zum Schützen und Steuern des API-Datenverkehrs, stellen die Endpunkte bereit, die APIs für die aufrufenden Anwendungen bereitstellen und stellen Assemblyfunktionen bereit, die die Integration von APIs in verschiedene Endpunkte ermöglichen. Sie protokollieren und melden außerdem alle API-Interaktionen an die API Connect -Analyseengine für Echtzeit-und Langzeitanalysen und Berichterstellung.

API Connect unterstützt die folgenden Arten von API-Gateways:

  • DataPower Gateway (v5-compatible)

    Das DataPower® Gateway ist ein unternehmensweites API Gateway, das für Abteilungen und den unternehmensübergreifenden Einsatz konzipiert ist. In V10 API Connect ist das DataPower Gateway kompatibel mit dem V5 DataPower Gateway, daher wird es in der Dokumentation als "v5-compatible" (oder "v5c") Gateway bezeichnet. Das v5-compatible Gateway stellt eine umfassende Gruppe von API-Richtlinien für Sicherheit, Datenverkehrsmanagement, Mediation, Beschleunigung und Unterstützung von Nicht-HTTP-Protokollen bereit.

  • DataPower API Gateway

    Das DataPower API Gateway wurde mit demselben Sicherheitsfokus wie das DataPower Gateway (v5-compatible) entworfen. Wenn DataPower Gateway (kompatibel mitv5 ) für Flexibilität erstellt wird, wird DataPower API Gateway speziell für den API-Anwendungsfall erstellt, mit den daraus resultierenden benefits.DataPower API Gateway ist für die Cloud optimiert. Verwenden Sie dieses Gateway, wenn Sie Anwendungen in einer öffentlichen oder privaten Cloud ausführen und sie als APIs bereitstellen möchten.

Ihre API Connect -Implementierung kann ein virtuelles DataPower Gatewayenthalten. Unterstützung für ein physisches DataPower Gateway ist ebenfalls verfügbar, sofern bestimmte Bedingungen erfüllt sind.

Weitere Informationen zu den Gateways und einen Vergleich ihrer Funktionen finden Sie unter Gateway-Typen.

Laufzeit

Sie können Anwendungen und API-Implementierungen in API Connect in einer containerisierten Laufzeit ausführen.
Containerisierte Laufzeit
Eine containerisierte Laufzeitumgebung bietet eine einfache Implementierungsposition für APIs und Anwendungen. Ein Container schließt eine Anwendung in ein vollständiges Dateisystem ein, das alles für die Ausführung benötigte enthält: Code, Laufzeit, Systemtools und Systembibliotheken. Sie können Docker Swarm-oder Kubernetes -Container verwenden, um Ihre APIs und Anwendungen auszuführen, die von API Connectverwaltet werden.

Entwicklerportal

Das Developer Portal stellt ein anpassbares webbasiertes Self-Service-Portal für Anwendungsentwickler zum Durchsuchen, Erkennen und Abonnieren von APIs bereit.

Wenn API-Provider APIs im API Managerveröffentlichen, sind diese APIs im Developer Portal für die Erkennung und Verwendung durch Anwendungsentwickler in Konsumentenorganisationen verfügbar. Anwendungsentwickler können auf die Benutzerschnittstelle des Developer Portal zugreifen, um ihre Anwendungen zu registrieren, APIs zu erkennen, die erforderlichen APIs in ihren Anwendungen zu verwenden (bei Bedarf mit Zugriffsgenehmigung), und diese Anwendungen anschließend implementieren.

Das Developer Portal stellt zusätzliche Funktionen wie Foren, Blogs, Kommentare und Bewertungen für die Sozialisierung und Zusammenarbeit bereit. API-Konsumenten können auch Analyseinformationen zu den APIs anzeigen, die von einer Anwendung oder in einer Konsumentenorganisation verwendet werden. Weitere Informationen finden Sie unter Developer Portal: Teilen Sie Ihre APIs.

API-Analyse

API Connect bietet die Möglichkeit, Ihre API-Ereignisdaten zu filtern, zu sortieren und zu aggregieren. Diese Daten werden dann in korrelierten Diagrammen, Tabellen und Karten dargestellt, um Sie bei der Verwaltung von Service-Levels, der Festlegung von Ratenbegrenzungen, der Einrichtung von Kontrollen, der Einrichtung von Sicherheitsrichtlinien, der Verwaltung von Communitys und der Analyse von Trends zu unterstützen. Die API-Analyse basiert auf der Open-Source-Engine OpenSearch für verteilte Suche und Analyse in Echtzeit. Weitere Informationen finden Sie unter Analyse: API-Nutzung verstehen.

API Connect -Servervoraussetzungen

Aus einer lokalen Cloud heraus können Sie APIs erstellen, hochstufen, verwenden und verfolgen. Eine lokale Cloud besteht aus verschiedenen Appliances, wobei jede Appliance ein Server eines bestimmten Typs ist. Durch diesen Serververbund wird Ihre Cloud definiert und bestimmt, wie die Arbeit (Verwalten, Analysieren, Routing und Speichern von Daten) verteilt werden soll.

Ihre lokale Cloud kann eine Kombination aus neuen und bestehenden Appliances (physisch und virtuell) sein oder kann komplett aus virtuellen Appliances bestehen. Der Typ und die Anzahl der Server in einer API Connect -Umgebung werden durch die individuellen Anforderungen jedes Unternehmens bestimmt, aber die Mindestvoraussetzung ist ein Management -Server, ein Analyseserver, ein Gateway -Server und ein Server zum Hosten des Developer Portal.

Die lokale API Connect -Cloud umfasst die folgenden Servertypen:
  • Management-Server. Speichert alle Cloudkonfigurationen und steuert die Kommunikation zwischen den anderen Servern in API Connect. Verwaltet die Operationen der verschiedenen Server in der API Connect -Cloud und stellt die Tools für die Schnittstelle mit den verschiedenen Servern bereit. Die Benutzerschnittstellen von Cloud Manager und API Manager werden auf dem Management -Server ausgeführt.
  • Analyseserver. Stellt stellt Analysefunktionen bereit, die Informationen über APIs und API-Benutzer erfassen und speichern.
  • Gateway-Server. Verarbeitet und verwaltet Sicherheitsprotokolle und speichert entsprechende Authentifizierungsdaten für den Benutzer und die Appliance. Der Gateway -Server stellt auch Assemblierungsfunktionen bereit, mit denen APIs in verschiedene Endpunkte, wie Datenbanken oder HTTP-basierte Endpunkte, integriert werden können.
  • Developer Portal -Server. Stellt ein anpassbares soziales Entwicklerportal mit einem Content-Management-System mit vielen Funktionen bereit und beinhaltet Clustering-Funktionen. Ermöglicht API-Providern das Erstellen von Portalen für ihre Anwendungsentwickler und stellt die Schnittstelle für Anwendungsentwickler zum Erkennen von APIs und zum Abonnieren von Nutzungsplänen, die in den veröffentlichten Produkten enthalten sind, zur Verwendung in ihren Anwendungen bereit.
Hinweis: Alle Management-Appliances in einer API Connect -Cloud müssen mit derselben Firmwareversion ausgeführt werden. Gateway-Appliances können mit unterschiedlichen Firmwareversionen ausgeführt werden, aber es wird empfohlen, alle Gateway-Appliances ebenfalls mit derselben Firmwareversion auszuführen.

Typische Tasks nach Schnittstellenkomponente

API Connect bietet sowohl Befehlszeilenschnittstellen als auch grafische Benutzerschnittstellen. Provider- und Konsumentenorganisationen nutzen verschiedene Schnittstellen für die Ausführung verschiedener typischer Tasks. In der folgenden Tabelle finden Sie die einer bestimmten Task entsprechende Schnittstelle.

Tabelle 1. API Connect Aufgaben pro Schnittstellenkomponente
Organisationstyp Schnittstellenkomponente Tasks
API-Provider Befehlszeilenschnittstelle (CLI) APIs, Pläne und Produkte erstellen
Benutzerschnittstelle von API Designer APIs, Pläne und Produkte erstellen
Benutzerschnittstelle von API Manager Kataloge und Bereiche erstellen; Konsumentenorganisationen erstellen
Benutzerschnittstelle von Cloud Manager Provider-Organisationen erstellen
API-Konsumenten (Anwendungsentwickler) Entwicklerportal Auf APIs zugreifen zum Erstellen und Ausführen von Anwendungen; Konsumentenorganisationen erstellen

Wenn das Self-Service-Onboarding für einen Katalog aktiviert ist, wird automatisch eine Konsumentenorganisation erstellt, wenn sich ein Anwendungsentwickler anmeldet oder vom API-Provider zu einem Developer Portaleingeladen wird, und der Anwendungsentwickler wird dann Eigner dieser Konsumentenorganisation.