Proxy-API Konfiguration im Jitterbit API-Manager

Einführung

Auf dieser Seite wird beschrieben, wie Sie über Meine APIs eine Proxy-API erstellen und konfigurieren. Seite von Jitterbit API-Manager. Eine Proxy-API ist eine von drei APIs Arten ü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.

Voraussetzungen

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

• 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 heißt, die API, die Sie als Proxy verwenden möchten, darf sich nicht hinter einer Firewall befinden. Informationen zum Zulassungsliste der IP-Adressen des Cloud API Gateways, um dem Gateway Zugriff auf die als Proxy verwendete 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 zulässt, verbraucht die Basis-Proxy-URL die Berechtigung.

Erstellen einer neuen Proxy-API

Wenn Sie auf den API-Manager Meine APIs zugreifen-Seite ist dieser Bildschirm leer, wenn in der ausgewählten Organisation keine benutzerdefinierte API, kein OData Dienst und keine Proxy-API vorhanden ist.

Um eine neue Proxy-API zu erstellen, klicken Sie auf Neuer Proxy:

Wenn Sie auf Neuer Proxy klicken, wird der Konfigurationsbildschirm der Proxy-API geöffnet. Einzelheiten zur Konfiguration einer neuen Proxy-API finden Sie unter Proxy-API konfigurieren 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 Anforderungsheader zuweisen

• Schritt 5: Zusammenfassung und Bestätigung

Die Service URL einer API ist die URL, die zum Verwenden der API mit der konfigurierten Authentifizierungsmethode verwendet wird. Die Teile 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 für interne Identifikationszwecke 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 erlaubt maximal 48 Zeichen und keine Leerzeichen oder bestimmte Sonderzeichen. Die Verwendung anderer Sonderzeichen als eines Punktes (.) oder Bindestrich (-) wird nicht empfohlen. Beispiele für Namenskonventionen sind inkrementelle Versionen, wie v1.0, v1.1, v1.2 usw. oder mithilfe eines Datums, an dem die API veröffentlicht wurde, wie z. B. 2021-08-28.

• Umgebung: Verwenden Sie das Menü, um die Umfeld auszuwählen, in der die API gespeichert wird. 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. Diese Sonderzeichen sind erlaubt:

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

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

• Debug-Modus aktivieren bis: Wählen Sie diese Option, um den debuggen-Modus zu aktivieren und ein entsprechendes Datum und eine Uhrzeit einzugeben, zu denen 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. Wenn dieser Modus aktiviert ist, behält das System den vollständigen Inhalt jeder API -Anfrage und-Antwort bis zu 24 Stunden ab dem Zeitpunkt des Empfangs des API Aufrufs bei und gilt für alle von der API ausgelösten Vorgänge.

  Notiz

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

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

  Notiz

  Diese Einstellung ist unabhängig von der Einstellung für das Operation Timeout in Integration Studio oder Design Studio. Die Einstellungen für das Zeitlimit für Operationen werden nur dann 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 für alle API Anfragen und-Antworten erzwungen (empfohlen).

  Wenn diese Option nicht ausgewählt ist, werden die über API -Anfragen und-Antworten übermittelten Daten nicht verschlüsselt und können von anderen abgefangen und eingesehen werden. Dadurch könnten möglicherweise vertrauliche Informationen preisgegeben werden.

• CORS aktivieren: Auswählen, um Cross-Origin Resource Sharing (CORS) zu aktivieren (nicht empfohlen). Die Standardeinstellung ist nicht ausgewählt.

  Warnung

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

• Ausführliches Protokollieren aktivieren: Wählen Sie diese Option aus, um das ausführliche Protokollieren zu aktivieren. Das ausführliche Protokollieren 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: Wenn aktiviert, 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 zum automatischen Erkennen der API-Dienste verwendet. Wählen Sie Nein, um den Vorgang zu überspringen, oder Ja, um einen zusätzlichen Bereich zum Bereitstellen des OpenAPI-Dokuments zu erweitern:

  

  • 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 die Datei mit Durchsuchen ausgewählt wurde:

    

  • 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 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 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: Wenn aktiviert, klicken Sie 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 an einem Schritt vorgenommenen Änderungen zu speichern. Sie werden in einer Meldung aufgefordert, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

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 dann 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 mithilfe der folgenden Felder manuell 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 ein (/).

    Hinweis

    Durch die Verwendung von Zeichen wie geschweiften Klammern ({ }) in einem Servicepfad ist bei der manuellen Definition von Services nicht möglich. Um nicht zulä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 jede Methode aus, die für den Dienst erstellt werden soll, und 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 zur Tabelle unten hinzuzufügen. Es muss mindestens ein Dienst hinzugefügt werden, um die Schaltfläche Weiter zu aktivieren.

• Hinzugefügte Dienste: Eine Tabelle zeigt alle Dienste an, die hinzugefügt wurden. 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: Wenn aktiviert, klicken Sie 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 alle verfügbaren Dienste auf einmal hinzugefügt werden.
  • Dienstname: Der zur Identifizierung des Dienstes verwendete Name.
  • Methode(n): Die Methoden, die auf den Dienst zutreffen.
  • 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: Wenn aktiviert, klicken Sie, 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 an einem Schritt vorgenommenen Änderungen zu speichern. Sie werden in einer Meldung aufgefordert, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 4: Zuweisen von Sicherheitsprofilen und Anforderungsheadern

• Sicherheitsprofil(e): Sicherheitsprofile werden verwendet, um 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 muss möglicherweise ein Sicherheitsprofil zugewiesen werden, 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.

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

  Notiz

  Standardmäßig 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 Bindestriche ersetzen (-) mit Unterstrichen (_) in den Request-Headern (außer den Request-Headern 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.

  • Eingehende überschreiben: Wählen Sie diese Option aus, um einen vorhandenen Header zu überschreiben, der denselben Schlüssel verwendet. Die Standardeinstellung ist nicht ausgewählt.

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

• Headerfelder: Die oben im Abschnitt Anforderungsheader zugewiesenen Headerfelder werden in einer Tabelle angezeigt. Um ein zugewiesenes Header 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: Wenn aktiviert, klicken Sie, 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.

• 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 ist dieselbe wie die in Schritt 1: Grundeinstellungen beschriebene. Sie können diese Einstellung direkt von diesem Schritt aus ändern und müssen nicht zum ersten Schritt zurückkehren.

• 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. Um Änderungen vorzunehmen, klicken Sie auf das Bearbeiten-Symbol, um zu Schritt 4: Sicherheitsprofile und Anforderungsheader zuweisen zurückzukehren.

• Export: Generiert und initiiert einen Download einer APK-Datei (apis-export.apk), das einen Export der API enthält (siehe APIs exportieren und importieren).

• Klon: Erstellt eine Kopie einer vorhandenen API. In der API Kopie wird dem Proxy-Namen Kopie von vorangestellt, dem Service-Stamm wird Kopie von vorangestellt und der Version wird -2 angehängt. 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. In einem Dialogfeld werden Sie aufgefordert, das Löschen der API zu bestätigen.

  Notiz

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

• Als Entwurf speichern: Speichert die API im Status Entwurf oder Veröffentlicht mit Entwurf:

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

• Speichern und 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 wird auf Ihr Abonnementlimit für Proxy-URL angerechnet, da die API zugänglich ist. Ein Dialogfeld zeigt an, dass die API live ist. Klicken Sie auf URL kopieren, um die Service-URL der API zu kopieren (siehe API Service URL):