Portalseite im Jitterbit API-Manager

Einführung

Die Portal-Seite wird vom Portal Manager aus verwaltet-Seite und ermöglicht Ihnen den Zugriff auf und die Verwendung der generierten interaktiven OpenAPI 2.0-Dokumentation zum Testen von benutzerdefinierten und Proxy-APIs. Diese Seite beschreibt die Benutzeroberfläche der Portal-Seite im API-Manager.

Auf die Portal-Seite kann entweder über die API-Manager Anwendung zugegriffen werden, über eine Einladung von einem Harmony-Organisationsadministrator oder über einen direkten Link für Benutzer mit ausreichenden Organisationsberechtigungen und Umfeld.

Zugriff auf die Portalseite

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 ist, muss in der API Konfiguration eine Rolle ausgewählt werden, der in einer Umfeld mindestens Lese-Zugriff gewährt wurde. Siehe diese Ressourcen:

  • Schritt 3: Benutzerrollen und Sicherheitsprofile zuweisen in benutzerdefinierte API Konfiguration

  • Schritt 3: Benutzerrollen und Sicherheitsprofile zuweisen in OData Dienstkonfiguration

• Die API Dokumentation muss zuvor über den Portal Manager erstellt und veröffentlicht worden sein. Seite.

Um auf die Portal-Seite zuzugreifen, wählen Sie im Harmony-Portalmenü API-Manager > Portal:

Zusätzlich zum Zugriff über das Harmony-Portalmenü kann auf die Portal-Seite wie folgt zugegriffen werden:

• Eine Einladung von einem Administrator der Harmony-Organisation über die Management Console Benutzerverwaltung Seite.

• Ein direkter Link für API Verbraucher, die sowohl über die Berechtigung ApiConsumer in einer Organisation als auch über mindestens Lesezugriff in einer Umfeld verfügen (siehe Harmony Berechtigungen und-Zugriff). Um den direkten Link zu erhalten, kopieren Sie entweder die URL der API-Manager -Portal-Seite oder den Link zum Anzeigen der API Dokumentation auf der Portal Manager-Seite.

  Um den direkten Link zu erhalten und ihn einem API Verbraucher bereitzustellen, der über die erforderliche Berechtigung und Zugriffsebene verfügt, führen Sie einen der folgenden Schritte aus:

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

  • Aus dem Portal Manager-Seite auf API Dokumentation anzeigen:

    

  Wenn Benutzer auf den Direktlink zum Portal zugreifen und noch nicht angemeldet sind, wird ihnen eine allgemeine Anmeldeseite angezeigt, die von der Anmeldeseite des Harmony-Portals getrennt ist. Die Anmeldeseite sieht jedoch anders aus als die für das Harmony Portal, sind die erforderlichen Anmeldeinformationen dieselben, die Sie auch für die Anmeldung beim Harmony-Portal verwenden.

  Nach der Anmeldung wird die Portal-Seite angezeigt. Auf der Portal-Seite wird die OpenAPI 2.0-Dokumentation angezeigt, die vom Portal Manager generiert wurde-Seite und ermöglicht Ihnen das Testen von benutzerdefinierten und Proxy APIs.

Header der Portalseite

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

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

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

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

• Umgebung: Zeigt die Umfeld an, auf die aktuell zugegriffen wird. Über das Menü können Sie eine andere Umfeld auswählen.

Testen von APIs

Sie können die interaktive Dokumentation verwenden, um benutzerdefinierte und Proxy-API Aufrufe zu testen und so zu überprüfen, ob sie ordnungsgemäß funktionieren.

Da es sich bei der Schnittstelle um dieselbe handelt wie die, die auf der Portal Manager-Seite generiert und beschrieben wird, siehe Test APIs im Portal Manager Seite.