API7 Enterprise v3.3.0 unterstützt API Portal

Übersicht über das Developer Portal

Das Developer Portal ist eine spezielle Plattform, die für API-Konsumenten (z. B. Drittanbieter-Entwickler und interne Teams) entwickelt wurde und einen einheitlichen Zugang zu API-Dokumentationen, Testtools und verwandten Ressourcen bietet. Dieses Portal erleichtert Entwicklern nicht nur das schnelle Verständnis und die Integration von APIs, sondern verbessert auch die Visualisierungs- und Kontrollfähigkeiten auf Management- und Sicherheitsebene. Für eine API-Gateway-Plattform bietet ein Developer Portal folgende Vorteile:

1. Vereinfachte API-Exposition: Durch die Konsolidierung von fragmentierter Dokumentation, Beispielen und Schnittstellenspezifikationen auf einer einheitlichen Plattform reduziert das Portal die Integrationskosten erheblich und beschleunigt die Produktintegration mit externen Systemen.

2. Verbesserte Effizienz in Forschung und Entwicklung sowie im Betrieb: Selbstbedienungsfunktionen wie das Nachschlagen von Dokumentationen, Tests und Debugging reduzieren wiederholte Kommunikation und die Wartung von Dokumentationen, wodurch die Gesamteffizienz gesteigert wird.

3. Zentralisiertes Management und Monitoring: Die Plattform bietet eine bessere Nachverfolgung der API-Nutzung, Antwortanalysen und die Überwachung von Schlüsselmetriken sowie die frühzeitige Erkennung potenzieller Probleme.

In API7 Enterprise 3.3.0 unterstützt das API7 Gateway nun die automatische Generierung eines Developer Portals direkt aus der vom Benutzer bereitgestellten API-Dokumentation. Diese Funktion ermöglicht es Organisationen, API-Ressourcen einfacher für externe Parteien zugänglich zu machen, während sie Entwicklern ein konsistentes und bequemes Erlebnis bieten.

API7 Provider Portal und Developer Portal

Als API-Management-Plattformen ergänzen sich das API7 Provider Portal und das Developer Portal, richten sich jedoch an unterschiedliche Zielgruppen und bieten unterschiedliche Funktionen.

API7 Provider Portal

Das API7 Provider Portal ist eine Management-Konsole, die speziell für API-Anbieter entwickelt wurde, um das API-Lebenszyklusmanagement zu erleichtern.

• Zielgruppe: API-Anbieter und Administratoren
• Kernfunktionen:
  • Veröffentlichen und Verwalten von API-Produkten.
  • Verwalten von Entwicklern.
  • Konfigurieren von Richtlinien für den Zugriff auf das Developer Portal, wie z. B. anonymes Anzeigen von APIs und Anmeldemethoden.
  • Visualisierung von API-Zugriffsstatistiken, Durchführung von Analysen und Nachverfolgung von Protokollen.

API7 Developer Portal

Das API7 Developer Portal bietet einen einheitlichen, selbstbedienungsfähigen Einstiegspunkt für Entwickler oder Partner, um API-Dienste schnell zu verstehen, darauf zuzugreifen und sie zu nutzen.

• Zielgruppe: API-Konsumenten, wie z. B. Drittanbieter-Entwickler, Partner oder interne Entwicklungsteams
• Kernfunktionen:
  • Bereitstellung von API-Dokumentationen, Nutzungsanleitungen und Beispielcode.
  • Angebot von Online-Tests und Debugging-Schnittstellen.
  • Verwaltung der Anwendungsregistrierung, Erhalt von API-Schlüsseln und Handhabung von Authentifizierungsdaten.

Verwendung des API7 Portals

Zugriff auf das API7 Provider Portal

Nach dem Anmelden am API7 Enterprise-Dashboard werden Benutzer standardmäßig zur Gateway-Management-Seite weitergeleitet. Um zum API7 Provider Portal zu wechseln, klicken Sie auf die Umschaltfläche in der oberen linken Ecke. Nach dem Wechsel wird der Seitentitel auf API7 Provider Portal aktualisiert, und das Menü auf der linken Seite zeigt die relevanten Optionen für die Verwaltung von API-Produkten an.

Erstellen und Veröffentlichen von API-Produkten

API-Produkte sind eine Kernressource im API7 Provider Portal und repräsentieren eine Gruppe verwandter APIs. Entwickler abonnieren APIs in der Regel auf Produktebene. Es gibt zwei Methoden zum Erstellen von API-Produkten.

1. Basierend auf veröffentlichten Diensten im API7 Gateway

• Wählen Sie bestehende veröffentlichte Dienste im API7 Gateway aus und gruppieren Sie sie in ein API-Produkt.
• Innerhalb des API-Produkts werden die entsprechenden Routen jedes Dienstes als unabhängige APIs behandelt.

2. Importieren von OpenAPI-Dateien

• Schnelles Generieren von API-Produkten durch Importieren bestehender OpenAPI-Dateien.
• Beachten Sie, dass auf diese Weise erstellte Produkte nicht direkt mit den Gateway-Konfigurationen verknüpft sind.

Beispiel: Hinzufügen eines API-Produkts aus dem API7 Gateway

Um ein API-Produkt hinzuzufügen, klicken Sie auf die Schaltfläche "Add API Product" und wählen Sie den Menüpunkt "From API7 Gateway", um zum Formular zur Erstellung von API-Produkten zu gelangen.

Im Formular müssen Sie folgende Informationen ausfüllen:

1. Grundlagen: Enthält Name, Beschreibung, Labels, Logo usw.

2. Authentifizierungstyp: Geben Sie an, ob eine Genehmigung erforderlich ist.

3. Sichtbarkeit: Legen Sie den Sichtbarkeitsbereich des API-Produkts fest.

4. Verknüpfte Gateway-Dienste: Wählen Sie einen veröffentlichten Gateway-Dienst aus, der die folgenden beiden Bedingungen erfüllt:

   • Ein Hostname wurde konfiguriert.
   • Ein OpenAPI-Dokument wurde hochgeladen.

Hinzufügen eines neuen API-Produkts

Wenn keine Dienste die Anforderungen erfüllen, können Sie die folgenden Konfigurationsschritte befolgen.

1. Hochladen des OpenAPI-Dokuments und Konfigurieren des Hostnamens für bestehende Dienste

Klicken Sie auf der Dienstdetailseite oder der Dienstvorlagenseite in der linken Navigationsleiste auf OpenAPI Specification. Laden Sie dann das entsprechende OpenAPI-Dokument für den Dienst hoch. Stellen Sie sicher, dass die API-Definitionen im Dokument genau mit den tatsächlichen Routen des Dienstes übereinstimmen. Dies gewährleistet, dass Entwickler während des Debuggens eine genaue API-Dokumentation erhalten und erfolgreich auf das Upstream zugreifen können.

Nach dem Hochladen des Dokuments können Sie es in Echtzeit anzeigen, was der endgültigen API-Dokumentation entspricht, auf die Entwickler zugreifen werden.

Konfigurieren Sie anschließend im Abschnitt Routes der Dienstdetailseite oder der Vorlagendetailseite die hosts im Modul Request URL. Standardmäßig ist hosts auf "*" gesetzt, was bedeutet, dass der Dienst Anfragen von jedem Hostnamen verarbeitet.

Um den Dienst mit einem API-Produkt zu verknüpfen, muss ein genauer Host angegeben werden. Diese Anforderung stellt sicher, dass Entwickler auf APIs mit dem vollständigen Pfadformat zugreifen können: host + path prefix + API.

2. Erstellen eines neuen Dienstes für die Verknüpfung mit einem API-Produkt

Wenn keine Dienste veröffentlicht wurden, können Sie einen neuen Dienst erstellen, indem Sie ein OpenAPI-Dokument als Dienstvorlage hochladen und veröffentlichen oder indem Sie einen Dienst direkt in der Gateway-Gruppe erstellen. Auf diese Weise erstellte Dienste parsen automatisch die im OpenAPI definierten APIs in Routen und behalten das Dokument bei, ohne es erneut hochladen zu müssen. Konfigurieren Sie den host wie zuvor beschrieben, um den Dienst für die Verknüpfung mit einem API-Produkt berechtigt zu machen.

Sobald die Gateway-Konfiguration abgeschlossen ist, kehren Sie zum Provider Portal zurück und klicken Sie auf Add Linked Gateway Service. Wählen Sie den erforderlichen veröffentlichten Dienst aus, um die Verknüpfung abzuschließen.

Standardmäßig befindet sich das neu erstellte API-Produkt im Entwurfsstatus und ist für Entwickler unsichtbar. Vor der Veröffentlichung sollten Sie die API-Dokumentation, die Sichtbarkeitseinstellungen und die Authentifizierungseinstellungen überprüfen. Es wird empfohlen, API-Produkt-Ereignisbenachrichtigungen (z. B. Genehmigung oder Kündigung von Abonnements) zu konfigurieren, um wichtige Updates nicht zu verpassen.

Veröffentlichen eines API-Produkts

Nach der Überprüfung des API-Produkts klicken Sie auf die Schaltfläche Publish in der oberen rechten Ecke und bestätigen. Entwickler, die den Sichtbarkeitseinstellungen entsprechen, können dann über das Developer Portal auf das Produkt zugreifen.

Zugriff auf das API7 Developer Portal

Sie können auf zwei Arten auf das API7 Developer Portal zugreifen:

1. Besuchen Sie die URL des Developer Portals.
2. Klicken Sie auf die Schaltfläche Developer Portal im linken Menü des API7 Portal-Dashboards.

Auf der Startseite des API7 Developer Portals klicken Sie auf die Schaltfläche Login in der oberen rechten Ecke, um sich anzumelden.

Erstellen eines Entwicklers

Es gibt zwei Möglichkeiten, ein Entwicklerkonto zu erstellen:

• Selbstregistrierung: Entwickler registrieren sich selbst auf der Anmeldeseite.
• Administrator-Einladung: Administratoren erstellen Konten über das API7 Portal-Dashboard.

Selbstregistrierung

Klicken Sie auf die Schaltfläche Sign up auf der Anmeldeseite und füllen Sie das Formular mit einem Benutzernamen und einem Passwort aus.

Administrator-Initierte Registrierung

Navigieren Sie im API7 Portal-Dashboard zum Abschnitt Developers und klicken Sie auf Invite Developer. Füllen Sie das Formular mit dem Benutzernamen und einem Einmalpasswort aus und geben Sie optional einen Anzeigenamen zur Identifikation an.

Nach dem Hinzufügen des Entwicklers teilen Sie den Benutzernamen und das Passwort mit dem Benutzer. Beim ersten Anmelden muss der Benutzer sein Passwort zurücksetzen.

Anzeigen von API-Produkten

Nach der Anmeldung können Entwickler auf API Hub klicken, um alle veröffentlichten API-Produkte anzuzeigen.

Neben der Anzeige der API-Dokumentation unterstützt das System auch die Generierung von Codebeispielen in mehreren Sprachen für jede API auf der Detailseite. Entwickler können diese Beispielcodes in ihre Entwicklungsumgebung kopieren, um sie zu testen.

Debuggen von API-Produkten

Darüber hinaus können Entwickler APIs direkt testen, indem sie auf die Schaltfläche Test Request klicken.

Nach dem Klicken auf Test Request wird ein Online-Testpanel angezeigt.

• Die Request URL wird automatisch basierend auf der Dienstkonfiguration generiert, die mit dem API-Produkt verknüpft ist.
• Die Authentifizierungsmethode ist standardmäßig auf Key Auth eingestellt und füllt automatisch den API-Schlüssel für das aktuelle Entwicklerkonto aus.

Entwickler müssen nur die erforderlichen Anfrageparameter gemäß der API-Schnittstellendefinition ergänzen, um mit dem Debuggen fortzufahren.

Abonnieren von API-Produkten

Wenn ein API-Produkt auf bestimmte Benutzer beschränkt ist, kann der Administrator des Provider Portals die Option Unsubscribed developers can view API details in den Sichtbarkeitseinstellungen des Produkts deaktivieren. Dadurch wird sichergestellt, dass Entwickler das Produkt abonnieren müssen, bevor sie auf dessen APIs zugreifen oder sie aufrufen können.

Wenn ein Entwickler unter dieser Einstellung auf die API-Produktdetailseite zugreift, wird eine Schaltfläche "Subscribe to Unlock" angezeigt. Durch Klicken auf die Schaltfläche wird eine Abonnementanfrage an den Provider-Administrator gesendet.

Wenn der Genehmigungsprozess für das API-Produkt aktiviert ist, muss der Entwickler auf die Genehmigung des Administrators warten, bevor er Zugriff auf die Details erhält.

Im Organisationsmenü des API7 Provider Portals erscheint ein roter Punkt neben dem Menüpunkt Approvals, wenn ausstehende Genehmigungen vorliegen. Durch Klicken auf diesen Menüpunkt gelangen Sie zur Genehmigungsverwaltungsseite.

Die Genehmigungsseite dient der Verwaltung von Anfragen von Entwicklern, auf API-Ressourcen zuzugreifen. Administratoren können auf dieser Seite folgende Anfrageinformationen einsehen: Ereignistyp, Ressourcenname, Antragsteller und Antragszeit. Über die Schnittstelle können Administratoren die Anfrage genehmigen oder ablehnen.

Die Genehmigungsentscheidung hat direkte Auswirkungen auf die API-Zugriffsberechtigungen des Entwicklers:

• Genehmigen: Der Entwickler erhält Zugriff auf die API-Produktdetailseite und kann die API aufrufen.
• Ablehnen: Der Entwickler muss mit dem Administrator kommunizieren, notwendige Anpassungen basierend auf dem Feedback vornehmen und die Anfrage erneut einreichen.

Fazit

API7 Enterprise integriert die API-Gateway-Plattform mit einem Developer Portal, um eine effiziente API-Management-Lösung für API-Anbieter und Entwickler zu schaffen.

Das API7 Provider Portal ermöglicht es API-Anbietern, API-Produkte einfach zu veröffentlichen, zu verwalten und zu überwachen, während sie Entwicklerressourcen effektiv koordinieren. Gleichzeitig können Entwickler API-Dienste schnell verstehen, integrieren und effizient nutzen, was die Anwendungsentwicklung beschleunigt. Diese beiden Portale arbeiten synergistisch zusammen, um den API-Lebenszyklusmanagementprozess zu optimieren und jeden Schritt – von der Bereitstellung bis zum Aufruf – nahtloser und effizienter zu gestalten.