Zum Inhalt springen

Seite „API Groups" im Jitterbit API Manager

Einführung

Die Seite API Groups im API Manager ermöglicht einem Harmony-Organisationsadministrator das Erstellen und Verwalten einer Gruppe von APIs, auf die externe Benutzer zugreifen können.

Alternativ können API-Gruppen mit dem APIM AI Assistant erstellt und verwaltet werden.

Um Aktionen auf der Seite API Groups auszuführen oder Änderungen vorzunehmen, ist eine Rolle mit der Berechtigung Admin erforderlich. Benutzer in Rollen mit Schreib-Umgebungszugriff können die Seite öffnen, aber den Inhalt nicht anzeigen.

Auf die Seite „API Groups" zugreifen

Um auf die Seite API Groups zuzugreifen, nutzen Sie das Harmony-Portalmenü, um API Manager > API Groups auszuwählen.

Kopfzeile der Seite „API Groups"

Die Kopfzeile oben auf der Seite API Groups enthält ein Suchfeld und eine Schaltfläche zum Erstellen einer neuen API-Gruppe:

header

  • Search: Geben Sie einen beliebigen Teil des Namens einer API-Gruppe in das Suchfeld ein, um API-Gruppen nach Name zu filtern. Die Suche ist nicht case-sensitiv, und der übereinstimmende Textteil wird hervorgehoben.

  • New: Klicken Sie, um eine der folgenden Optionen auszuwählen:

    • Build with AI: Öffnet den APIM Assistant zum Erstellen einer API-Gruppe mit natürlichsprachigen Eingabeaufforderungen. Weitere Informationen finden Sie unter Den AI Assistant verwenden.

      Hinweis

      Um den APIM AI Assistant zu verwenden, muss Ihre Harmony-Lizenz die Option APIM AI Assistant enthalten. Wenden Sie sich an Ihren Customer Success Manager (CSM), um diese Option zu Ihrer Lizenz hinzuzufügen.

    • API Group: Öffnet die API-Gruppenkonfiguration, um manuell eine neue API-Gruppe zu erstellen.

Eine API-Gruppe erstellen

Wenn Sie API Group aus dem Menü New in der Kopfzeile der Seite auswählen, wird diese Benutzeroberfläche geöffnet:

add new group

  • API group name: Geben Sie einen Namen ein, um die API-Gruppe zu kennzeichnen.

  • Environment: Wählen Sie die Umgebung aus, um alle APIs in dieser Umgebung in die API-Gruppe einzubeziehen.

  • API: Wählen Sie nacheinander eine API aus, um sie in die API-Gruppe einzubeziehen. Wenn Sie auf den Namen einer einzelnen API klicken, werden weitere Informationen über die API im rechten Bereich angezeigt, wie z. B. die Version der API, die Service-URL und die der API zugewiesenen Operationen.

  • Save: Klicken Sie, um die API-Gruppe zu speichern und die Konfiguration zu schließen.

  • Cancel: Klicken Sie, um die API-Gruppe zu verwerfen und die Konfiguration zu schließen.

API-Gruppen

Vorhandene API-Gruppen werden wie folgt angezeigt und verfügen über diese Optionen:

API groups

  • View: Klicken Sie, um weitere Details über die API-Gruppe anzuzeigen.

  • Edit: Klicken Sie, um die APIs in der API-Gruppe hinzuzufügen oder zu entfernen.

  • Delete: Klicken Sie, um die API-Gruppe zu löschen.

Eine API-Gruppe anzeigen

Wenn Sie eine API-Gruppe anzeigen, wird diese Benutzeroberfläche angezeigt:

view API groups

  • API: Der Name der API.

  • Version: Die Version der API.

  • Environment: Die Umgebung der API.

  • Path: Das URL-Präfix, die API-Version und der Service-Root der API-Service-URL.

  • Copy: Klicken Sie, um den Path in die Zwischenablage zu kopieren.