Zum Inhalt springen

API-Gruppen-Seite im Jitterbit API-Manager

Einführung

Die API-Gruppen-Seite im API-Manager ermöglicht es einem Administrator der Harmony-Organisation, eine Gruppe von APIs zu erstellen und zu verwalten, auf die externe Benutzer zugreifen können.

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

Hinweis

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

Um Aktionen auszuführen oder Änderungen auf der API-Gruppen-Seite vorzunehmen, ist eine Rolle mit Admin-Berechtigung erforderlich. Benutzer in Rollen mit Write-Zugriff auf die Umgebung können die Seite öffnen, jedoch nicht den Inhalt einsehen.

Zugriff auf die API-Gruppen-Seite

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

Kopfzeile der API-Gruppen-Seite

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

header

  • Suche: Geben Sie einen Teil des Namens einer API-Gruppe in das Suchfeld ein, um API-Gruppen nach Namen zu filtern. Die Suche ist nicht groß-/kleinschreibungsempfindlich.

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

    • Mit AI erstellen: Öffnet den APIM Assistant, um eine API-Gruppe mit natürlichen Sprachaufforderungen zu erstellen. Weitere Informationen finden Sie unter Verwendung des AI Assistant.

      Hinweis

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

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

API-Gruppe erstellen

Wenn Sie API-Gruppe aus dem Neu-Menü in der Kopfzeile der Seite auswählen, öffnet sich diese Benutzeroberfläche:

Neue Gruppe hinzufügen

  • Name der API-Gruppe: Geben Sie einen Namen ein, um die API-Gruppe zu identifizieren.

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

  • API: Wählen Sie nacheinander eine API aus, die in die API-Gruppe aufgenommen werden soll. Ein Klick auf den Namen einer einzelnen API zeigt zusätzliche Informationen über die API im rechten Bereich an, wie die Version der API, die Service-URL und die der API zugewiesenen Operationen.

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

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

API-Gruppen

Vorhandene API-Gruppen werden wie folgt angezeigt und haben diese Optionen:

API-Gruppen

  • Anzeigen: Klicken Sie, um weitere Details zur API-Gruppe anzuzeigen.

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

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

API-Gruppe anzeigen

Beim Anzeigen einer API-Gruppe wird Ihnen diese Benutzeroberfläche präsentiert:

API-Gruppen anzeigen

  • API: Der Name der API.

  • Version: Die Version der API.

  • Umgebung: Die Umgebung der API.

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

  • Kopieren: Klicken Sie, um den Pfad in Ihre Zwischenablage zu kopieren.