Proxy-API Konfiguration im Jitterbit API-Manager

Einführung

Auf dieser Seite wird beschrieben, wie Sie eine Proxy-API aus den APIs erstellen und konfigurieren Seite von Jitterbit API-Manager. Eine Proxy-API ist eine von drei APIs-Typen über den API-Manager konfiguriert. Informationen zu den beiden anderen Typen - benutzerdefinierte API und OData Dienst - finden Sie unter Custom API Konfiguration und OData-Dienstkonfiguration.

Notiz

Nach der Veröffentlichung zählt jede Proxy-API als Proxy-URL zu Ihrem Harmony Abonnementkontingent.

Voraussetzungen

Im Gegensatz zu einer benutzerdefinierten API oder einem OData Dienst, der eine Harmony Operation zur Nutzung bereitstellt, wird eine Proxy API mit einer vorhandenen API verwendet. Proxy APIs werden nicht über Jitterbit-Agenten geroutet. Die Proxy API muss für das Gateway, das die API verarbeitet, zugänglich sein:

• Cloud API -Gateway: Bei Verwendung des Cloud API Gateways (gehostet von Jitterbit) Die vorhandene API muss öffentlich zugänglich sein, auch wenn sie gesichert ist. Das bedeutet, dass die API, die Sie proxyen möchten, nicht hinter einer Firewall liegen darf. Informationen zum Zulassungsliste der IP-Adressen des Cloud API Gateways, um dem Gateway Zugriff auf die geproxte API zu gewähren, finden Sie unter Informationen zur Whitelist und navigieren Sie zu https://services.jitterbit für Ihre Region.
• Privates API -Gateway: Bei Verwendung eines privaten API Gateways (auf einem privaten Netzwerk gehostet) muss die vorhandene API über das private API Gateway zugänglich sein.

Obwohl jede Proxy-API die Zuweisung mehrerer Dienste zu einer eindeutigen URL ermöglicht, verbraucht die Basis-Proxy-URL die Berechtigung.

Notiz

Zugriffe aller Dienste auf eine Proxy-URL werden summiert und auf die in der Jitterbit-Lizenzvereinbarung festgelegten Zugriffsrechte für Zugriffe pro Monat und Minute angerechnet. Informationen zu Berechtigungen und Ratenbegrenzungen mit Sicherheitsprofilen finden Sie unter Ratenbegrenzungen verwenden auf API-Manager Sicherheit.

Erstellen einer neuen Proxy API

Wenn Sie auf den API-ManagerAPIs zugreifen-Seite: Wenn in der ausgewählten Organisation keine benutzerdefinierte API, OData Dienst und keine Proxy-API vorhanden ist, ist dieser Bildschirm leer.

So erstellen Sie eine neue Proxy-API: Neu > Proxy-API:

Wenn Sie auf Proxy-API klicken, wird der Konfigurationsbildschirm der Proxy-API geöffnet. Details zur Konfiguration einer neuen Proxy-API finden Sie unter [Proxy-API konfigurieren].#proxyapiconfiguration-configuring-a-proxy-api) unten.

Konfigurieren einer Proxy-API

Der Konfigurationsbildschirm der Proxy-API umfasst fünf Konfigurationsschritte, die im Folgenden beschrieben werden:

• Schritt 1: Grundeinstellungen

• Schritt 2: Vorhandene API

• Schritt 3: Dienste und Methoden definieren

• Schritt 4: Sicherheitsprofile und Anfrageheader zuweisen

• Schritt 5: Zusammenfassung und Bestätigung

Die Service-URL einer API ist die URL, die zur Nutzung der API mit der konfigurierten Authentifizierungsmethode verwendet wird. Die Bestandteile der Service-URL einer API werden unter API-Manager - Erste Schritte beschrieben. in API -Dienst URL.

Die Service URL wird oben in jedem Schritt angezeigt:

Schritt 1: Grundeinstellungen

• Proxyname: Geben Sie einen Namen für die Proxy-API ein, der zur internen Identifikation verwendet werden soll. Folgende Sonderzeichen sind zulässig:

  ( ) - _

• Versionsnummer: Geben Sie eine optionale Version ein, die als Teil der Service-URL der API verwendet werden soll. Dieses Feld ist auf maximal 48 Zeichen begrenzt und erlaubt keine Leerzeichen oder bestimmte Sonderzeichen. Die Verwendung anderer Sonderzeichen als Punkte (.) oder Bindestrich (-) wird nicht empfohlen. Beispiele für Namenskonventionen sind inkrementelle Versionen, wie z. B. v1.0, v1.1, v1.2usw. oder mithilfe eines Datums, an dem die API veröffentlicht wurde, wie etwa 2021-08-28.

• Umgebung: Wählen Sie über das Menü die Umfeld aus, in der die API gespeichert werden soll. Sie können einen beliebigen Teil des Umfeld in das Menü eingeben, um die Liste der Umgebungen zu filtern. Die Menüergebnisse werden mit jedem Tastendruck in Echtzeit gefiltert.

  Notiz

  Nach der API -Erstellung kann die Umfeld nicht mehr geändert werden. Um eine API zwischen Umgebungen zu verschieben, können Sie die API klonen oder exportieren und importieren die API in einer anderen Umfeld.

• Service-Root: Der öffentliche Name der API, der als Teil der Service-URL der API verwendet werden soll. Standardmäßig wird dieses Feld mit dem Proxy-Namen in Camel Case ausgefüllt. Dieses Feld erlaubt keine Leerzeichen oder bestimmte Sonderzeichen. Die Verwendung anderer Sonderzeichen als Unterstriche (_) wird nicht empfohlen. Folgende Sonderzeichen sind zulässig:

  . _ ~ ( ) $ ; / ? : @ = & ' ! * , + -

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

• Debug-Modus aktivieren bis: Aktivieren Sie diesen Modus und geben Sie ein Datum und eine Uhrzeit ein, ab wann der debuggen Modus deaktiviert wird. Die maximale Aktivierungsdauer beträgt zwei Wochen. Der Debug-Modus ermöglicht die vollständige Nachverfolgung aller über die Service-URL der API empfangenen Anfragen. Ist der Debug-Modus aktiviert, speichert das System den vollständigen Inhalt jeder API Anfrage und-Antwort bis zu 24 Stunden nach dem Empfang des API Aufrufs. Dies gilt für alle von der API ausgelösten Vorgänge.

  Notiz

  Das Durchsuchen der Ereignisdaten kann bei großen Datenmengen (Lasttests, Vorproduktionstests usw.) schwierig werden. Die Zunahme der gespeicherten Daten kann zu Speicherplatz- und Sicherheitsproblemen führen. Wir empfehlen, den debuggen Modus in einer Umfeld nicht zu verwenden.

• Timeout: Geben Sie die Anzahl der Sekunden ein, nach denen die API abläuft. Der Standardwert beträgt 30 Sekunden. Das Maximum beträgt 180 Sekunden.

  Notiz

  Diese Einstellung ist unabhängig von der Timeout-Einstellung für den Operation in Integration Studio oder Design Studio. Die Timeout-Einstellungen für den Vorgang werden nur verwendet, wenn EnableAPITimeout Einstellung in der privaten Agent-Konfigurationsdatei ist aktiviert.

• Nur SSL: Wenn ausgewählt (Standard), werden die Daten über SSL verschlüsselt und HTTPS wird für alle API Anfragen und-Antworten erzwungen (empfohlen).

  Wenn diese Option nicht aktiviert ist, werden die über API Anfragen und-Antworten übermittelten Daten nicht verschlüsselt und können von anderen abgefangen und eingesehen werden. Dies könnte möglicherweise vertrauliche Informationen offenlegen.

• CORS aktivieren: Wählen Sie diese Option, um Cross-Origin Resource Sharing (CORS) zu aktivieren (nicht empfohlen). Die Standardeinstellung ist deaktiviert.

  Warnung

  Die Aktivierung von CORS führt dazu, dass Operationen mit dem OPTIONS Methode zur Ausführung ohne Authentifizierung.

• Ausführliche Protokollierung aktivieren: Aktivieren Sie diese Option, um die ausführliche Protokollierung zu aktivieren. Die ausführliche Protokollierung für APIs umfasst Anforderungs- und Antwortdaten in jedem API Protokoll, um eingehende und ausgehende Daten zu überwachen und die Fehlerbehebung zu erleichtern. Die Standardeinstellung ist deaktiviert.

• Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren.

• Änderungen speichern: Klicken Sie hier, um die Konfiguration für diesen Schritt zu speichern und zu Schritt 5: Zusammenfassung und Bestätigung zu navigieren.

Schritt 2: Vorhandene API

• Basis-API URL: Geben Sie die Basis URL der API zum Proxy ein.

  Notiz

  Wenn die API einen einzelnen Dienst bereitstellt, können Sie die vollständige API URL einschließlich des Dienstpfads eingeben. Weitere Dienstpfade werden in Schritt 3: Dienste und Methoden definieren definiert.

• OpenAPI-Dokument bereitstellen: Wenn ein OpenAPI-Dokument bereitgestellt wird, wird es zur automatischen Erkennung der API-Dienste verwendet. Wählen Sie Nein, um den Vorgang zu überspringen, oder Ja, um einen zusätzlichen Bereich für die Bereitstellung des OpenAPI-Dokuments zu öffnen:

  

  • URL laden: Öffnet einen Dialog zum Laden eines OpenAPI-Dokuments im YAML- oder JSON-Format von einer URL:

    

  • Datei hochladen: Öffnet einen Dialog zum Hochladen eines OpenAPI-Dokuments im YAML- oder JSON-Format, nachdem Sie die Datei mit Durchsuchen ausgewählt haben:

    

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

  • Dokumenteditor: Ermöglicht das Anzeigen und Bearbeiten eines bereitgestellten OpenAPI-Dokuments. Sie können ein OpenAPI-Dokument auch direkt hier bereitstellen. Um das OpenAPI-Dokument in einem größeren Bereich anzuzeigen und zu bearbeiten, klicken Sie auf das Popup-Symbol (nachdem Sie diesen Bereich geöffnet haben, klicken Sie auf das Zurück-Symbol , um zu diesem Bildschirm zurückzukehren.

• Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren.

• Änderungen speichern: Klicken Sie (falls aktiviert) hier, um die Konfiguration für diesen Schritt zu speichern und navigieren Sie zu Schritt 5: Zusammenfassung und Bestätigung.

• Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen auf, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Sie werden in einer Meldung aufgefordert, das Verwerfen der Änderungen zu bestätigen.

Schritt 3: Dienste und Methoden definieren

Die Art und Weise, wie Dienste und Methoden definiert werden, hängt davon ab, ob die Auswahl in Schritt 2: Vorhandene API für OpenAPI-Dokument bereitstellen war Nein oder Ja:

• Nein: Wenn kein OpenAPI-Dokument bereitgestellt wurde, müssen Dienste und Methoden manuell definiert werden (siehe Manuelle Definition unten).
• Ja: Wenn ein OpenAPI-Dokument bereitgestellt wurde, werden Dienste und Methoden automatisch aus dem OpenAPI-Dokument erkannt und anschließend ausgewählt (siehe Automatische Erkennung von OpenAPI-Dokumenten unten).

Manuelle Definition

• Dienste und Methoden definieren: Wenn in Schritt 2: Vorhandene API kein OpenAPI-Dokument bereitgestellt wurde, müssen Sie die Dienste und Methoden manuell mithilfe der folgenden Felder definieren:

  • Dienstname: Geben Sie einen Namen zur Identifizierung des Dienstes ein.

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

    Hinweis

    Verwenden Sie Zeichen wie geschweifte Klammern ({ }) in einem Servicepfad ist bei der manuellen Definition von Services nicht möglich. Um unzulässige Zeichen in einem Servicepfad zu verwenden, stellen Sie stattdessen ein OpenAPI-Dokument bereit, das den Pfad in Schritt 2: Vorhandene API definiert.

  • Methoden: Wählen Sie die für den Dienst zu erstellenden Methoden aus. Wählen Sie aus: GET, PUT, POST, DELETE und Benutzerdefiniert. Wenn Benutzerdefiniert ausgewählt ist, geben Sie eine oder mehrere benutzerdefinierte Methoden, getrennt durch Kommas, in das unten angezeigte Textfeld ein:

    

• Dienst hinzufügen: Sobald alle Felder ausgefüllt sind, klicken Sie auf Dienst hinzufügen, um den Dienst der Tabelle unten hinzuzufügen. Mindestens ein Dienst muss hinzugefügt werden, um die Schaltfläche Weiter zu aktivieren.

• Hinzugefügte Dienste: In einer Tabelle werden alle hinzugefügten Dienste angezeigt. Um einen hinzugefügten Dienst zu entfernen, klicken Sie auf das Symbol „Entfernen“.

• Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren.

• Änderungen speichern: Klicken Sie (falls aktiviert) hier, um die Konfiguration für diesen Schritt zu speichern und navigieren Sie zu Schritt 5: Zusammenfassung und Bestätigung.

Automatische OpenAPI-Dokumentenerkennung

• Dienste und Methoden definieren: Wenn in Schritt 2: Vorhandene API ein OpenAPI-Dokument bereitgestellt wurde, werden seine Dienste automatisch aus dem OpenAPI-Dokument erkannt und in einer Tabelle mit diesen Spalten aufgelistet:
  • Auswählen: Wählen Sie die Dienste aus, die zur Proxy-API hinzugefügt werden sollen. Über das Kontrollkästchen in der Header können Sie alle verfügbaren Dienste gleichzeitig hinzufügen.
  • Dienstname: Der zur Identifizierung des Dienstes verwendete Name.
  • Methode(n): Die Methoden, die für den Dienst gelten.
  • Pfad: Der Pfad des Dienstes.
• Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren.
• Änderungen speichern: Klicken Sie, falls aktiviert, um die Konfiguration für diesen Schritt zu speichern und zu Schritt 5: Zusammenfassung und Bestätigung zu navigieren.
• Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen auf, um die Konfiguration zu schließen, ohne die Änderungen an einem Schritt zu speichern. Sie werden in einer Meldung aufgefordert, das Verwerfen der Änderungen zu bestätigen.

Schritt 4: Zuweisen von Sicherheitsprofilen und Anforderungsheadern

• Sicherheitsprofil(e): Sicherheitsprofile dienen dazu, den Zugriff auf die API einzuschränken. Sie können einen beliebigen Teil des Sicherheitsprofilnamens in das Menü eingeben, um die Liste der Sicherheitsprofile zu filtern. Die Menüergebnisse werden mit jedem Tastendruck in Echtzeit gefiltert. Je nach den Richtlinien der Harmony Organisation kann die Zuweisung eines Sicherheitsprofils erforderlich sein, um die API zu speichern.

  • Verfügbare Profile: Verwenden Sie die Dropdown-Liste, um ein vorhandenes Sicherheitsprofil auszuwählen.

  • Profil zuweisen: Klicken Sie hier, um der API ein ausgewähltes Sicherheitsprofil zuzuweisen.

  • Neues Profil erstellen Klicken Sie hier, um ein neues Sicherheitsprofil zu erstellen. Anweisungen finden Sie unter Sicherheitsprofilkonfiguration.

• Zugewiesene Profile: Eine Tabelle listet die zugewiesenen Sicherheitsprofile auf. Um ein zugewiesenes Profil zu entfernen, klicken Sie auf das Symbol „Entfernen“.

• Anfrage-Header: Mit den folgenden Einstellungen können neue Anfrage-Header hinzugefügt oder vorhandene Anfrage-Header überschrieben werden.

  Notiz

  Standardmäßig ist der Header disable-hyphen-replacement ist eingestellt auf true für alle neuen Proxy APIs. Sobald die Proxy-API veröffentlicht ist, kann der Header auf false um Bindestriche zu ersetzen (-) mit Unterstrichen (_) in Anforderungsheadern (mit Ausnahme der Anforderungsheader Content-Type, Content-Length, Accept-Encoding, Und Transfer-Encoding).

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

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

  • Eingehenden überschreiben: Wählen Sie diese Option aus, um einen vorhandenen Header zu überschreiben, der denselben Schlüssel verwendet. Die Option ist standardmäßig deaktiviert.

  • Header-Feld zuweisen: Nachdem ein Schlüssel und ein Wert eingegeben wurden, klicken Sie, um den Header der API zuzuweisen.

• Header-Felder: Die oben im Abschnitt Anforderungsheader zugewiesenen Header-Felder werden in einer Tabelle angezeigt. Um ein zugewiesenes Header Feld zu entfernen, klicken Sie auf das Symbol „Entfernen“.

• Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren. Wenn der API kein erforderliches Sicherheitsprofil zugewiesen ist, ist diese Option deaktiviert.

• Änderungen speichern: Klicken Sie, falls aktiviert, um die Konfiguration für diesen Schritt zu speichern und navigieren Sie zu Schritt 5: Zusammenfassung und Bestätigung. Wenn der API kein erforderliches Sicherheitsprofil zugewiesen ist, ist diese Option deaktiviert.

Schritt 5: Zusammenfassung und Bestätigung

• Proxyname und Umgebung: Der API -Name und die Umfeld, wie in [Schritt 1: Grundeinstellungen] konfiguriert.#proxyapiconfiguration-step1basic).

• Beschreibung, Timeout, Nur SSL, CORS aktiviert und Ausführliche Protokollierung aktiviert: Die API Beschreibung und andere aktivierte Einstellungen () oder deaktiviert (). Um Änderungen an diesen Einstellungen vorzunehmen, klicken Sie auf das Bearbeiten-Symbol, um zu Schritt 1: Grundeinstellungen zurückzukehren.

  • Debug-Modus aktivieren bis: Diese Option entspricht der unter Schritt 1: Grundeinstellungen beschriebenen. Sie können diese Einstellung direkt von diesem Schritt aus ändern, ohne zum ersten Schritt zurückkehren zu müssen.

• Vorhandene API: Die Basis API URL, die in Schritt 2: Vorhandene API bereitgestellt wird. Um Änderungen vorzunehmen, klicken Sie auf das Bearbeiten-Symbol, um zu Schritt 2: Vorhandene API zurückzukehren.

• Dienste und Methoden: Die in Schritt 3: Dienste und Methoden definieren definierten Dienste. Um Änderungen vorzunehmen, klicken Sie auf das Bearbeiten-Symbol, um zu Schritt 3: Dienste und Methoden definieren zurückzukehren.

• Sicherheitsprofile und Anforderungsheader: Die in [Schritt 4: Sicherheitsprofile und Anforderungsheader zuweisen] zugewiesenen Sicherheitsprofile und Anforderungsheader.#proxyapiconfiguration-step4profile). Um Änderungen vorzunehmen, klicken Sie auf das Bearbeiten-Symbol, um zu Schritt 4: Sicherheitsprofile und Anforderungsheader zuweisen zurückzukehren.

• Export: Generiert und startet den Download einer APK-Datei (apis-export.apk), die einen Export der API enthält (siehe Exportieren und Importieren von APIs).

• Klonen: Erstellt eine Kopie einer vorhandenen API. In der API Kopie wird dem Proxy-Namen Kopie von, dem Service-Root Kopie von und der Version -2 vorangestellt. Die API Kopie wird sofort in einem eigenen Schritt 5: Zusammenfassung und Bestätigung geöffnet.

• Löschen: Löscht die API dauerhaft und schließt die Konfiguration. Sie werden in einem Dialogfeld aufgefordert, das Löschen der API zu bestätigen.

  Notiz

  Wenn die API zum Zeitpunkt der Löschung den Status Veröffentlicht oder Veröffentlicht mit Entwurf hatte, wird sie auch von der Anzahl der Proxy-URLs abgezogen, die für Ihr Abonnementlimit verwendet werden. Wenn die API zum Zeitpunkt der Löschung den Status Entwurf hatte, ändert sich die Anzahl der Proxy-URLs nicht, da die API im Status Entwurf nicht zugänglich war.

• Als Entwurf speichern: Speichert die API im Status Entwurf oder Mit Entwurf veröffentlicht:

  • Entwurf: Eine neue API oder eine API, die zum Zeitpunkt der Verwendung von Als Entwurf speichern den Status Entwurf hatte. Entwürfe werden nicht auf Ihr Proxy-URL-Abonnementlimit angerechnet.
  • Veröffentlicht als Entwurf: Eine API, deren Status zum Zeitpunkt von Als Entwurf speichern Veröffentlicht war, wird verwendet. Eine als Entwurf veröffentlichte API wird auf Ihr Proxy-URL-Abonnementlimit angerechnet, da die API zugänglich ist, der Entwurf jedoch nicht.

• Speichern und veröffentlichen: Speichert die API im Status Veröffentlicht. Die API ist innerhalb von fünf Minuten verfügbar. Eine veröffentlichte API wird auf Ihr Proxy-URL-Abonnementlimit angerechnet, da die API verfügbar ist. Ein Dialog zeigt an, dass die API verfügbar ist. Klicken Sie auf URL kopieren, um die Service-URL der API zu kopieren (siehe API Service URL):