Proxy-API-Konfiguration im Jitterbit API Manager

Einführung

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

Voraussetzungen

Im Gegensatz zu einer benutzerdefinierten API oder OData-API, die eine Harmony-Operation zur Nutzung bereitstellt, wird eine Proxy-API mit einer bestehenden API verwendet. Proxied APIs werden nicht über Jitterbit-Agenten geleitet. Das Gateway, das die API verarbeitet, muss auf die API zugreifen können, die proxied wird:

• Cloud-API-Gateway: Wenn Sie das Cloud-API-Gateway (gehostet von Jitterbit) verwenden, muss die bestehende API öffentlich zugänglich sein, auch wenn sie gesichert ist. Die API, die Sie proxied möchten, darf sich nicht hinter einer Firewall befinden. Um die IP-Adressen des Cloud-API-Gateways auf die Allowlist zu setzen, damit das Gateway Zugriff auf die proxied API hat, siehe Allowlist-Informationen und navigieren Sie zu https://services.jitterbit für Ihre Region.

• Privates API-Gateway: Wenn Sie ein privates API-Gateway (gehostet in einem privaten Netzwerk) verwenden, muss das private API-Gateway auf die bestehende API zugreifen können.

Obwohl jede Proxy-API mehrere Dienste einer einzigartigen URL zuweisen kann, verbraucht die Basis-Proxy-URL das Anrecht.

Erstellen einer neuen Proxy-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 Proxy-API zu erstellen, klicken Sie auf Neu > Proxy-API.

Konfigurieren einer Proxy-API

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

• Profil-Registerkarte (erforderlich)
• Einstellungen-Registerkarte (optional)
• Vorhandene API-Registerkarte (erforderlich)
• Dienste-Registerkarte (erforderlich)
• Sicherheitsprofile-Registerkarte (optional)
• Anforderungsheader-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 Proxy-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 Proxy-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 wird. Dieses Feld erlaubt maximal 48 Zeichen und erlaubt keine Leerzeichen oder bestimmte Sonderzeichen. Die Verwendung von Sonderzeichen außer einem Punkt (.) oder einem Bindestrich (-) wird nicht empfohlen. Übliche Namenskonventionen umfassen inkrementierende 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:

• Timeout: 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 Timeout-Einstellung für Operationen in Studio oder Design Studio. Timeout-Einstellungen für Operationen werden nicht verwendet, es sei denn, die Einstellung EnableAPITimeout in der Konfigurationsdatei des privaten Agents ist aktiviert.

• Nur SSL: 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 Registerkarte Einstellungen konfiguriert haben, klicken Sie auf Weiter, um zur Registerkarte Existierende API zu gelangen, oder klicken Sie auf Zurück, um zur Registerkarte Profil zurückzukehren.

Existierende API-Registerkarte

Verwenden Sie die Registerkarte Existierende API, um die Basis-URL der API anzugeben, die Sie proxyen möchten, und optional ein OpenAPI-Dokument für die automatische Dienstentdeckung bereitzustellen.

Konfigurieren Sie die folgenden Einstellungen:

• Basis-API-URL: Geben Sie die Basis-URL der API ein, die Sie proxen möchten.

  Hinweis

  Wenn die API einen einzelnen Dienst bereitstellt, können Sie die vollständige API-URL einschließlich des Dienstpfads eingeben. Zusätzliche Dienstpfade sind im Services-Tab definiert.

• OpenAPI-Dokument bereitstellen: Wenn Sie ein OpenAPI-Dokument bereitstellen, verwendet der API-Manager es zur automatischen Entdeckung der Dienste der API. Wählen Sie Nein, um zu überspringen, oder Ja, um einen zusätzlichen Bereich zum Bereitstellen des OpenAPI-Dokuments zu erweitern:

  

  • URL laden: Öffnet einen Dialog, um ein OpenAPI-Dokument im YAML- oder JSON-Format von einer URL zu laden:

    

  • Datei hochladen: Öffnet einen Dialog, um ein OpenAPI-Dokument im YAML- oder JSON-Format hochzuladen, nachdem Sie Durchsuchen verwendet haben, um die Datei auszuwählen:

    

  • Löschen: Löscht ein bereits bereitgestelltes OpenAPI-Dokument und ändert die Auswahl OpenAPI-Dokument bereitstellen auf Nein.

  • Dokumenten-Editor: Ermöglicht das Anzeigen und Bearbeiten eines bereitgestellten OpenAPI-Dokuments. Sie können auch ein OpenAPI-Dokument bereitstellen, indem Sie es hier direkt eingeben. Um das OpenAPI-Dokument in einem größeren Bereich anzuzeigen und zu bearbeiten, klicken Sie auf das Popout-Symbol. Nachdem Sie diesen Bereich geöffnet haben, klicken Sie auf das Rückkehrsymbol, um zu diesem Bildschirm zurückzukehren.

Nachdem Sie den Existing API-Tab konfiguriert haben, klicken Sie auf Weiter, um zum Services-Tab zu gelangen, oder klicken Sie auf Zurück, um zum Einstellungen-Tab zurückzukehren.

Services-Tab

Verwenden Sie die Registerkarte Dienste, um die Dienste und HTTP-Methoden zu definieren, die die Proxy-API bereitstellen wird. Die Art und Weise, wie Sie Dienste definieren, hängt davon ab, ob Sie ein OpenAPI-Dokument im Register "Bestehende API" bereitgestellt haben.

Manuelle Dienstdefinition

Wenn Sie kein OpenAPI-Dokument bereitgestellt haben, müssen Sie die Dienste und Methoden manuell definieren:

Klicken Sie auf Neuer Dienst, um einen Dienst hinzuzufügen. Konfigurieren Sie die folgenden Einstellungen:

• Dienstname: Geben Sie einen Namen ein, um den Dienst zu identifizieren.

• Pfad: Geben Sie einen Pfad für den Dienst ein. Wenn die API keinen Dienstpfad hat, geben Sie einen Schrägstrich (/) ein.

  Hinweis

  Sie können keine Zeichen wie geschweifte Klammern ({ }) in einem Dienstpfad verwenden, wenn Sie Dienste manuell definieren. Um nicht erlaubte Zeichen in einem Dienstpfad zu verwenden, stellen Sie stattdessen ein OpenAPI-Dokument bereit, das den Pfad im Register "Bestehende API" definiert.

• Methoden: Wählen Sie jede Methode aus, die für den Dienst erstellt werden soll. Verfügbare Methoden sind GET, PUT, POST und DELETE. Um eine nicht aufgeführte Methode zu verwenden, geben Sie den Methodennamen im Textfeld Geben Sie eine neue Methode ein ein und drücken Sie Enter.

• 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.
  • Duplizieren: Klicken Sie, um den Dienst zu duplizieren.
  • Löschen: Klicken Sie, um den Dienst zu löschen.

Sie müssen mindestens einen Dienst hinzufügen, um zur nächsten Registerkarte fortzufahren.

Automatische Entdeckung des OpenAPI-Dokuments

Wenn Sie ein OpenAPI-Dokument im Register "Bestehende API" bereitgestellt haben, entdeckt der API-Manager automatisch die Dienste und listet sie in einer Tabelle auf:

• Zuweisen: Verwenden Sie den Schalter, um die Dienste zur Proxy-API hinzuzufügen.
• Dienstname: Der Name, der verwendet wird, um den Dienst zu identifizieren.
• Methoden: Die HTTP-Methode, die für den Dienst gilt.
• Pfad: Der Pfad des Dienstes.

• 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.
  • Zum API-Dienst gehen: Klicken Sie, um die API in einer Wizard-Oberfläche zu konfigurieren.

Nachdem Sie die Registerkarte Dienste konfiguriert haben, klicken Sie auf Weiter, um zur Registerkarte Sicherheitsprofile zu gelangen, oder klicken Sie auf Zurück, um zur Registerkarte Bestehende API zurückzukehren.

Registerkarte Sicherheitsprofile

Die Registerkarte Sicherheitsprofile ist optional und ermöglicht es Ihnen, den Zugriff auf die Nutzung der API einzuschrä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 in Sicherheitsprofilen konfiguriert.

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

• Benutzername: Bei der Basis-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 Sicherheitsprofilzeile, um zusätzliche Aktionen anzuzeigen.

  • Zum Sicherheitsprofil gehen: 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 die Registerkarte Sicherheitsprofile konfiguriert haben, klicken Sie auf Weiter, um zur Registerkarte Anforderungsheader zu gelangen, oder klicken Sie auf Zurück, um zur Registerkarte Dienste zurückzukehren.

Registerkarte Anforderungsheader

Die Registerkarte Anforderungsheader ist optional und ermöglicht es Ihnen, neue Anforderungsheader hinzuzufügen oder vorhandene Anforderungsheader zu überschreiben.

Klicken Sie auf Neuer Header, um einen Anforderungsheader hinzuzufügen. Konfigurieren Sie die folgenden Einstellungen:

• Schlüssel: Geben Sie einen Schlüssel für den Anforderungsheader ein.

• Wert: Geben Sie einen Wert für den Anforderungsheader ein.

• Eingehendes Überschreiben: Aktivieren Sie diesen Schalter, um einen vorhandenen Anforderungsheader, der denselben Schlüssel verwendet, zu überschreiben. Standardmäßig ist dies deaktiviert.

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

  • Löschen: Klicken Sie, um den Anforderungsheader zu löschen.

Nachdem Sie die Registerkarte Anforderungsheader 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.

Optionen zum Speichern und Veröffentlichen

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. Entwurfs-APIs zählen nicht gegen Ihr Proxy-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 Proxy-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 Proxy-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.
  • 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.