Portal-Seite im Jitterbit API Manager

Einführung

Die Portal-Seite wird von der Portal-Verwaltung verwaltet und ermöglicht den Zugriff auf die generierte interaktive OpenAPI 2.0-Dokumentation, um benutzerdefinierte und Proxy-APIs zu testen. Diese Seite beschreibt die Benutzeroberfläche der Portal-Seite innerhalb des API Managers.

Die Portal-Seite kann entweder über die API Manager-Anwendung, über eine Einladung von einem Harmony-Organisationsadministrator oder über einen direkten Link für diejenigen mit ausreichenden Organisationsberechtigungen und Umgebungszugriff aufgerufen werden.

Zugriff auf die Portal-Seite

Bevor Sie auf die Portal-Seite zugreifen können, müssen diese Kriterien erfüllt sein:

• Für jede API, deren Dokumentation über die Portal-Seite zugänglich wird, muss eine Organisationsrolle ausgewählt werden, die in einer Umgebung mindestens _Lese-_Zugriff gewährt hat. Siehe diese Ressourcen:

  • Schritt 3: Benutzerrollen und Sicherheitsprofile zuweisen in der benutzerdefinierten API-Konfiguration

  • Schritt 3: Benutzerrollen und Sicherheitsprofile zuweisen in der OData-Dienstkonfiguration

• Die API-Dokumentation muss zuvor über die Portal-Verwaltung generiert und veröffentlicht worden sein.

Um auf die Portal-Seite zuzugreifen, verwenden Sie das Harmony-Portal-Menü, um API Manager > Portal auszuwählen.

Zusätzlich zum Zugriff über das Menü des Harmony-Portals kann die Portal-Seite folgendermaßen aufgerufen werden:

• Durch eine Einladung von einem Harmony-Organisationsadministrator über die Seite Benutzerverwaltung der Management-Konsole.

• Über einen direkten Link für API-Nutzer, die sowohl die Berechtigung ApiConsumer in einer Organisation als auch mindestens Lesen-Zugriff in einer Umgebung haben (siehe Harmony-Berechtigungen und -Zugriff). Um den direkten Link zu erhalten, kopieren Sie entweder die URL der API-Manager Portal-Seite oder den Link zu API-Dokumentation anzeigen auf der Portal-Manager-Seite.

  Um den direkten Link bereitzustellen, der an einen API-Nutzer mit den erforderlichen Berechtigungen und Zugriffsrechten gegeben werden kann, führen Sie eine der folgenden Aktionen aus:

  • Gehen Sie zur Portal-Seite und kopieren Sie deren URL.

  • Klicken Sie auf der Seite Portal-Manager auf API-Dokumentation anzeigen:

    

  Beim Zugriff auf den direkten Link zum Portal wird den Nutzern, die nicht bereits angemeldet sind, eine allgemeine Anmeldeseite angezeigt, die von der Anmeldeseite des Harmony-Portals getrennt ist. Obwohl die Anmeldeseite anders aussieht als die für das Harmony-Portal, sind die erforderlichen Anmeldedaten dieselben wie die, die zum Anmelden im Harmony-Portal verwendet werden.

  Nach der Anmeldung wird die Portal-Seite angezeigt. Die Portal-Seite zeigt die OpenAPI 2.0-Dokumentation an, die von der Seite Portal-Manager generiert wurde, und ermöglicht es Ihnen, benutzerdefinierte und Proxy-APIs zu testen.

Portal-Seitenkopf

Diese Details und Aktionen sind oben auf der Portal-Seite verfügbar:

• Organisation: Der Name der aktuell ausgewählten Organisation, auf die zugegriffen wird.

• Basis-URL: Die Basis-URL der APIs in der Organisation.

  • Kopieren: Klicken, um die Basis-URL in die Zwischenablage zu kopieren.

• Umgebung: Zeigt die aktuell aufgerufene Umgebung an. Verwenden Sie das Menü, um eine andere Umgebung auszuwählen.

Test-APIs

Sie können die interaktive Dokumentation verwenden, um benutzerdefinierte und Proxy-API-Aufrufe zu testen, um zu validieren, dass sie ordnungsgemäß funktionieren.

Da die Benutzeroberfläche dieselbe ist wie die, die auf der Seite Portal Manager generiert und beschrieben wird, siehe Test-APIs auf der Seite Portal Manager.