Benutzerdefinierte API-Konfiguration im Jitterbit API Manager

Einführung

Diese Seite beschreibt, wie man eine benutzerdefinierte API von der APIs Seite des Jitterbit API Managers erstellt und konfiguriert. Benutzerdefinierte APIs sind eine der drei API-Typen, die über den API Manager konfiguriert werden. Für die beiden anderen Typen, OData API und Proxy API, siehe OData API-Konfiguration und Proxy API-Konfiguration.

Alternativ können Sie benutzerdefinierte APIs erstellen, indem Sie den AI Assistant verwenden oder im Studio die Option Als API veröffentlichen aus dem Aktionsmenü einer Operation nutzen.

Benutzerdefinierte APIs (veröffentlicht und Entwurf) werden an diesen Orten angezeigt:

• Auf der APIs Seite des API Managers.
• Im Ressourcen-Tab des Projektfensters für das Studio-Projekt, das mit der benutzerdefinierten API verbunden ist.

Voraussetzungen

Eine benutzerdefinierte API stellt eine Harmony-Operation zur Verfügung. Sie müssen zuerst diese Operation in Harmony erstellen und bereitstellen, bevor Sie die benutzerdefinierte API konfigurieren können. Die Operation, die eine benutzerdefinierte API auslöst, kann entweder eine Studio oder Design Studio Operation sein.

Für Anweisungen zur Erstellung und Bereitstellung einer Operation siehe diese Ressourcen:

• Studio
  • Erstellung und Konfiguration von Operationen
  • Bereitstellung und Ausführung von Operationen
• Design Studio
  • Erstellen einer Operation

Erstellen Sie eine neue benutzerdefinierte API

Wenn Sie die API-Manager-Seite APIs aufrufen und keine benutzerdefinierten APIs, OData-APIs oder Proxy-APIs in der ausgewählten Organisation vorhanden sind, ist dieser Bildschirm leer.

Um eine neue benutzerdefinierte API zu erstellen, klicken Sie auf Neu > Benutzerdefinierte API.

Konfigurieren Sie eine benutzerdefinierte API

Der Konfigurationsbildschirm umfasst mehrere Registerkarten, darunter zwei erforderliche und drei optionale Registerkarten. Jede Registerkarte wird in den folgenden Abschnitten behandelt:

• Profil-Registerkarte (erforderlich)
• Einstellungen-Registerkarte (optional)
• Dienste-Registerkarte (erforderlich)
• Sicherheitsprofile-Registerkarte (optional)
• Benutzerrollen-Registerkarte (optional)

Profil-Registerkarte

Verwenden Sie die Profil-Registerkarte, um grundlegende Informationen einzugeben, die die API identifizieren.

Konfigurieren Sie die folgenden Einstellungen:

• API-Name: Geben Sie einen Namen für die API ein, der für interne Identifikationszwecke verwendet wird. Die folgenden Sonderzeichen sind erlaubt: ( ) - _.

• Service Root: Der öffentliche Name der API, der als Teil der Service-URL der API verwendet wird. Standardmäßig wird dieses Feld mit dem API-Namen gefüllt, der in Camel Case umgewandelt wurde. In diesem Feld sind keine Leerzeichen oder bestimmte Sonderzeichen erlaubt. Die Verwendung von Sonderzeichen außer einem Unterstrich (_) wird nicht empfohlen. Die folgenden Sonderzeichen sind erlaubt: . _ ~ ( ) $ ; / ? : @ = & ' ! * , + -.

• Beschreibung: Geben Sie eine optionale Beschreibung für die API ein.

• Umgebung: Verwenden Sie das Menü, um die Umgebung auszuwählen, in der die API reside. Sie können einen Teil des Umgebungsnamens in das Menü eingeben, um die Liste der Umgebungen zu filtern. Die Menüergebnisse werden in Echtzeit mit jedem Tastendruck gefiltert.

  Hinweis

  Nach der Erstellung der API können Sie die Umgebung nicht mehr ändern. Um eine API zwischen Umgebungen zu verschieben, können Sie die API klonen oder die API in einer anderen Umgebung exportieren und importieren.

• Versionsnummer: Geben Sie eine optionale Version ein, die als Teil der API-Dienst-URL verwendet werden soll. Dieses Feld erlaubt maximal 48 Zeichen und keine Leerzeichen oder bestimmte Sonderzeichen. Die Verwendung von Sonderzeichen außer einem Punkt (.) oder einem Bindestrich (-) wird nicht empfohlen. Übliche Namenskonventionen umfassen inkrementelle Versionen wie v1.0, v1.1, v1.2 oder die Verwendung eines Datums, an dem die API veröffentlicht wurde, wie 2025-08-28.

Nachdem Sie die Profil-Registerkarte abgeschlossen haben, klicken Sie auf Weiter, um zur Einstellungen-Registerkarte zu gelangen, oder klicken Sie auf Als Entwurf speichern, um Ihren Fortschritt zu speichern.

Einstellungen-Registerkarte

Die Einstellungen-Registerkarte ist optional und enthält erweiterte Konfigurationsoptionen für die API.

Konfigurieren Sie die folgenden Einstellungen nach Bedarf:

• Zeitüberschreitung: Geben Sie die Anzahl der Sekunden ein, bevor die API eine Zeitüberschreitung hat. Der Standardwert beträgt 30 Sekunden. Der maximal zulässige Wert beträgt 180 Sekunden.

  Hinweis

  Diese Einstellung ist unabhängig von der Zeitüberschreitungseinstellung für Operationen in Studio oder Design Studio. Einstellungen zur Zeitüberschreitung von Operationen werden nicht verwendet, es sei denn, es wird ein privater Agent verwendet und die Einstellung EnableAPITimeout in der Konfigurationsdatei des privaten Agents ist aktiviert.

• SSL nur: Dieser Schalter ist standardmäßig aktiviert und erfordert HTTPS für die API. Wenn aktiviert, werden Daten über SSL verschlüsselt, und eine HTTP-Anfrage gibt einen Fehler zurück. Wenn deaktiviert, werden sowohl HTTP- als auch HTTPS-Anfragen unterstützt.

  Warnung

  Wenn deaktiviert, sind die über API-Anfragen und -Antworten übermittelten Daten nicht verschlüsselt und können von anderen abgefangen und eingesehen werden. Dies könnte potenziell sensible Informationen offenlegen.

• CORS: Aktivieren Sie diesen Schalter, um CORS (Cross-Origin Resource Sharing) zu unterstützen. CORS ist ein Mechanismus, der es Webanwendungen, die in einem Webbrowser auf einer Domain ausgeführt werden, ermöglicht, auf Ressourcen von einem Server auf einer anderen Domain zuzugreifen.

  Warnung

  Das Aktivieren von CORS führt dazu, dass Vorgänge, die die OPTIONS-Methode verwenden, ohne Authentifizierung ausgeführt werden.

• Ausführliches Protokollieren: Aktivieren Sie diesen Schalter, um Anforderungsheader und Payloads zu protokollieren, wenn eine API-Anfrage gestellt wird.

  Warnung

  Ausführliches Protokollieren kann sensible Daten wie Authentifizierungsanmeldeinformationen oder personenbezogene Daten enthalten. Verwenden Sie diese Einstellung mit Vorsicht.

• Debug-Modus aktivieren bis: Aktivieren Sie diesen Schalter, um detailliertes Protokollieren zur Fehlersuche zu aktivieren, und klicken Sie dann auf das Kalendersymbol, um ein Datum bis zu zwei Wochen ab heute auszuwählen, an dem der Debug-Modus automatisch deaktiviert wird. Wenn Sie den Debug-Modus für Vorgänge aktivieren, die durch diese API ausgelöst werden, enthalten die API-Protokolle Anforderungs- und Antwortdaten (30 Tage lang aufbewahrt), auf die Sie über die Management Console Runtime Seite zugreifen können. Standardmäßig protokolliert der API-Manager nur API-Vorgänge mit Fehlern.

  Warnung

  Debug-Protokolle enthalten alle Anforderungs- und Antwortdaten, einschließlich sensibler Informationen wie Passwörter und personenbezogene Daten (PII). Diese Daten erscheinen im Klartext in den Harmony-Cloud-Protokollen für 30 Tage.

Nachdem Sie die Einstellungen-Registerkarte konfiguriert haben, klicken Sie auf Weiter, um zur Dienste-Registerkarte zu gelangen, oder klicken Sie auf Zurück, um zur Profil-Registerkarte zurückzukehren.

Dienste-Registerkarte

Die Dienste-Registerkarte ist der Ort, an dem Sie die API-Dienste konfigurieren, die definieren, wie die API auf Anfragen reagiert. Sie können mehrere Dienste für eine einzelne benutzerdefinierte API konfigurieren. Jeder Dienst muss eine eindeutige Kombination aus HTTP-Methode und Pfad haben.

Klicken Sie auf Neuer Dienst, um einen neuen API-Dienst hinzuzufügen. Konfigurieren Sie die folgenden Einstellungen für jeden Dienst:

• Dienstname: Geben Sie einen beschreibenden Namen für diesen API-Dienst ein.

• Methode: Wählen Sie die HTTP-Methode für diesen Dienst aus dem Dropdown-Menü. Verfügbare Methoden sind GET, POST, PUT, DELETE und ALL. Um eine nicht aufgeführte Methode zu verwenden, geben Sie den Methodennamen in das Textfeld Geben Sie eine neue Methode ein ein und drücken Sie Enter.

• Pfad: Geben Sie den URL-Pfad ein, der diesen Dienst auslöst. Der Pfad wird an die Dienst-Root in der API-Dienst-URL angehängt.

• Projekt: Wählen Sie das Harmony-Projekt aus, das die Operation enthält, die dieser Dienst auslöst.

  • Zum Projekt gehen: Klicken Sie, um ein Studio-Projekt in einem neuen Browser-Tab zu öffnen. Diese Option ist für Design Studio-Projekte deaktiviert.

• Auszulösende Operation: Wählen Sie die spezifische Operation aus dem gewählten Projekt aus, die dieser Dienst bei Aufruf ausführt.

  Wichtig

  Standardmäßig werden erfolgreiche Operationen, die für eine benutzerdefinierte API konfiguriert sind, nicht in den Betriebsprotokollen aufgeführt, es sei denn, eine dieser Einstellungen ist aktiviert:

  • Cloud-Agenten: Für API-Operationen auf einem Cloud-Agenten muss das Betriebs-Debug-Protokoll für die Operation aktiviert sein.
  • Private Agenten: Für API-Operationen auf einem privaten Agenten muss entweder das Betriebs-Debug-Protokoll für die Operation aktiviert sein oder Sie müssen EnableLogging=true im Abschnitt [APIOperation] der Konfigurationsdatei des privaten Agenten festlegen.

  Fehlgeschlagene Operationen werden in den Operationsprotokollen protokolliert, unabhängig davon, ob die oben genannten Einstellungen aktiviert sind oder nicht.

• Antworttyp: Wählen Sie aus, wie die API die Betriebsantwort zurückgibt. Verfügbare Optionen sind Endziel, Systemvariable und Keine Antwort.

  • Endziel: Die API-Antwort ist das Endziel der Betriebskette. Wenn Sie diesen Antworttyp auswählen, muss die ausgewählte Operation als Endziel der Betriebskette eine Studio API-Antwortaktivität oder Variable Write-Aktivität, oder ein Design Studio API-Antwortziel oder Globales Variablenziel haben. Wenn die Operation ein anderes Endziel verwendet, bleibt die API-Antwort leer.

  • Systemvariable: Die API-Antwort wird in einer Jitterbit-Variable in der Betriebskette festgelegt. Wenn Sie diesen Antworttyp auswählen, muss die ausgewählte Operation als Teil der Betriebskette ein Skript haben, das die Jitterbit-Variable jitterbit.api.response gleich der Antwort setzt, die Sie von der API zurückgeben möchten. Wenn das Skript diese Variable nicht setzt, bleibt die API-Antwort leer.

  • Keine Antwort: Die API-Antwort ist leer. Wenn die Anfrage zur Ausführung der ausgewählten Operation akzeptiert wird, gibt die API sofort eine leere Antwort mit dem HTTP-Code 202 zurück.

• Aktionen: Fahren Sie mit der Maus über eine Dienstzeile, um zusätzliche Aktionen anzuzeigen.

  • API-Dienst-URL kopieren: Klicken Sie, um die API-Dienst-URL zu kopieren.
  • Gehe zu API-Dienst: Klicken Sie, um eine Übersicht über die Konfiguration der benutzerdefinierten API auf einer einzigen Seite zu sehen.
  • Duplizieren: Klicken Sie, um den API-Dienst zu duplizieren.
  • Löschen: Klicken Sie, um den API-Dienst zu löschen.

Nachdem Sie die grundlegenden Dienstkonfigurationseinstellungen konfiguriert haben, können Sie zusätzliche Parameter über die Registerkarten unter der Dienstkonfiguration konfigurieren:

Path params tab

Wenn Anforderungsparameter im Path enthalten sind, zeigt diese Registerkarte die im Pfad definierten Parameter an:

• Parameter: Zeigt jeden im Path definierten Anforderungsparameter an.

• Beschreibung: Geben Sie optional eine Beschreibung für den Anforderungsparameter ein.

Query params tab

Diese Registerkarte ermöglicht es Ihnen, Abfrageparameter zum API-Dienst hinzuzufügen:

• Add Parameter: Klicken Sie, um einen Abfrageparameter zum API-Dienst hinzuzufügen. Die folgenden Felder werden verfügbar:

  • Parameter: Geben Sie den Namen des Abfrageparameters ein.

  • Beschreibung: Geben Sie optional die Beschreibung des Abfrageparameters ein.

  • Delete: Klicken Sie auf das Löschen-Symbol neben einem Abfrageparameter, um diesen Parameter zu löschen.

Headers tab

Diese Registerkarte ermöglicht es Ihnen, Anforderungsheader zum API-Dienst hinzuzufügen:

• Add Header: Klicken Sie, um einen Anforderungsheader zum API-Dienst hinzuzufügen. Die folgenden Felder werden verfügbar:

  • Parameter: Geben Sie den Namen des Anforderungsheaders ein.

  • Beschreibung: Geben Sie optional eine Beschreibung für den Anforderungsheader ein.

  • Required: Wählen Sie das Kontrollkästchen aus, um diesen Header für API-Anfragen erforderlich zu machen.

  • Delete: Klicken Sie auf das Löschen-Symbol neben einem Anforderungsheader, um diesen Header zu löschen.

Sie können mehrere Dienste für eine einzelne benutzerdefinierte API konfigurieren. Jeder Dienst muss eine eindeutige Kombination aus HTTP-Methode und Pfad haben.

Verwenden Sie die Spalte Actions, um vorhandene Dienste zu bearbeiten oder zu löschen.

Nachdem Sie den Tab Services konfiguriert haben, klicken Sie auf Next, um zum Tab Sicherheitsprofile zu gelangen, oder klicken Sie auf Prev, um zum Tab Einstellungen zurückzukehren.

Tab Sicherheitsprofile

Der Tab Sicherheitsprofile ist optional und ermöglicht es Ihnen, den Zugriff auf die API zu beschränken.

Konfigurieren Sie die folgenden Einstellungen:

• Zuweisen: Verwenden Sie den Schalter, um Sicherheitsprofile für die API zuzuweisen oder zu entfernen.

• Profilname: Der Name des Sicherheitsprofils, wie im Sicherheitsprofile konfiguriert.

• Typ: Der Authentifizierungstyp für das Sicherheitsprofil, wie Basic, OAuth 2.0 oder API-Schlüssel.

• Benutzername: Bei der grundlegenden Authentifizierung wird der Benutzername angezeigt. Bei anderen Authentifizierungstypen wird derselbe Wert wie in der Spalte Typ angezeigt.

• Aktionen: Fahren Sie mit der Maus über eine Zeile eines Sicherheitsprofils, um zusätzliche Aktionen anzuzeigen.

  • Gehe zu Sicherheitsprofil: Klicken Sie, um die Konfiguration des Sicherheitsprofils zu öffnen.

Je nach den Richtlinien der Harmony-Organisation müssen Sie möglicherweise ein Sicherheitsprofil zuweisen, um die API zu speichern.

Klicken Sie auf Neues Sicherheitsprofil, um ein neues Sicherheitsprofil zu erstellen. Für Anweisungen siehe Sicherheitsprofile konfigurieren.

Nachdem Sie den Tab Sicherheitsprofile konfiguriert haben, klicken Sie auf Next, um zum Tab Benutzerrollen zu gelangen, oder klicken Sie auf Prev, um zum Tab Services zurückzukehren.

Benutzerrollen-Registerkarte

Die Benutzerrollen-Registerkarte ist optional und bestimmt, welche Organisationsrollen im API Manager Zugriff auf die API haben.

Konfigurieren Sie die folgenden Einstellungen:

• Benutzerrolle: Der Name der Organisationsrolle, wie sie auf der Registerkarte Rollen der Benutzerverwaltungsseite definiert ist.

• Berechtigungen: Die diesem Rolle zugewiesenen Berechtigungen, wie Lesen oder Admin.

• Status: Gibt an, ob die Rolle dieser API zugewiesen ist. Schalten Sie den Status um, um Rollen zuzuweisen oder zu entfernen.

• Aktionen: Fahren Sie mit der Maus über eine Zeile der Benutzerrolle, um zusätzliche Aktionen anzuzeigen.

  • Zur Benutzerrolle gehen: Klicken Sie, um die Konfiguration der Benutzerrolle zu öffnen.

Die hier ausgewählten Rollen bestimmen den Zugriff auf diese spezifische API von diesen Seiten:

• APIs
• Portal-Manager, einschließlich der Erstellung von API-Dokumentationen
• API-Portal
• API-Protokolle
• Analytik

Der Zugriff auf die Seite Sicherheitsprofile und der Zugriff auf die Nutzung der API sind von dieser Auswahl nicht betroffen. Der Zugriff auf die Nutzung einer API wird durch Sicherheitsprofile gesteuert.

Alle definierten Benutzerrollen mit der Admin-Berechtigung haben immer vollen Zugriff auf alle APIs und können daher nicht von der Auswahl entfernt werden.

Klicken Sie auf Neue Benutzerrolle, um eine neue Benutzerrolle zu erstellen. Für Anweisungen siehe Rollen in Benutzerverwaltung.

Nachdem Sie die Benutzerrollen-Registerkarte konfiguriert haben, klicken Sie auf Veröffentlichen, um die API zu veröffentlichen, oder klicken Sie auf Als Entwurf speichern, um Ihren Fortschritt zu speichern.

Speicher- und Veröffentlichungsoptionen

Nachdem Sie alle erforderlichen Registerkarten konfiguriert haben, können Sie die API speichern oder veröffentlichen:

• Als Entwurf speichern: Speichert die API im Status Entwurf oder Veröffentlicht mit Entwurf. Entwurf-APIs zählen nicht gegen Ihr API-URL-Abonnementlimit. Eine API, deren Status zum Zeitpunkt der Verwendung von Als Entwurf speichern Veröffentlicht war, wird als Veröffentlicht mit Entwurf gespeichert. Eine veröffentlichte API zählt gegen Ihr API-URL-Abonnementlimit, auch wenn ihr Entwurf nicht zugänglich ist.

• Veröffentlichen: Speichert die API im Status Veröffentlicht. Die API ist live und innerhalb von fünf Minuten zugänglich. Eine veröffentlichte API zählt gegen Ihr API-URL-Abonnementlimit. Ein Dialog zeigt an, dass die API live ist:

  

  Der Dialog bietet diese Optionen:

  • URL kopieren: Kopiert die Service-URL der API in Ihre Zwischenablage.
  • OpenAPI-Dokument generieren: Öffnet die Seite Portal Manager, auf der Sie die API-Dokumentation für die Seite API-Portal generieren können.
  • Schließen: Schließt den Dialog.

API bearbeiten

Nachdem Sie die API gespeichert haben, können Sie sie von diesen Standorten aus bearbeiten:

• Verwenden Sie die Kachelansicht auf der APIs-Seite, klicken Sie auf Anzeigen/Bearbeiten.
• Verwenden Sie die Listenansicht auf der APIs-Seite, klicken Sie auf Bearbeiten in der Spalte Aktionen.