Zum Inhalt springen

Verwandeln Sie Ihre Kontakte in Urlaubsgeld mit unserem neuen Kundenempfehlungsprogramm! Erfahren Sie mehr

✕

Installieren Sie ein privates Jitterbit API Gateway unter Linux

Übersicht

Auf dieser Seite wird erläutert, wie Sie ein privates API Gateway installieren, konfigurieren und testen.

Wichtig

EMEA-Kunden mit eingeschränkten Netzwerkumgebungen sollten aufgrund einer Umfeld die API Gateway-Version 11.40 oder höher verwenden.

Systemanforderungen

In diesem Abschnitt sind die Mindestanforderungen für einen API -Gateway Host aufgeführt.

Hardware

CPU Intel x86_64 (amd64) Quad-Core, 8 GB Arbeitsspeicher.
Festplatte 50 GB, NTFS (Windows), ext2, ext4, xfs (Linux), 50 MB/s Übertragungsgeschwindigkeit.
Netzwerk Highspeed-Internetverbindung.

Wichtig

Festplattengeschwindigkeit und -speicherplatz sind kritische Komponenten des privaten API Gateways, da Anforderungs- und Antwortnutzdaten während API -Transaktionen auf dem Server gespeichert werden.

Betriebssysteme

Betriebssystem Version ≤11.36 11.37 11.38 11.39 ≥11.40
Linux Red Hat Enterprise Linux 8
Red Hat Enterprise Linux 9
Amazon Linux AMI 2
Amazon Linux 2023
Ubuntu 20.04 LTS
Ubuntu 24.04 LTS
Docker

Hinweis

Nicht aufgeführte Distributionen funktionieren möglicherweise, werden aber nicht unterstützt.

Netzwerk

  • Eine Subdomain oder ein Domainname, der auf den Server verweist (z. B. mysubdomain.example.com).

  • Ein gültiges SSL-Zertifikat für die Subdomain von einer anerkannten Zertifizierungsstelle; verwenden Sie kein selbstsigniertes Zertifikat.

    Das Zertifikat sollte aus zwei Dateien bestehen: einer CRT-Datei (.crt) für das signierte Zertifikat und KEY (.key) für den privaten Schlüssel. Diese sollten im PEM-Format vorliegen, das ein NGINX-Server verstehen kann. (Manchmal unterscheiden sich die Dateierweiterungen; oft sind die Erweiterungen CRT, PEM und CER austauschbar.) Es ist auch möglich, dass die beiden Dateien in einer einzigen PFX-Datei zusammengefasst sind. Verwenden Sie in diesem Fall OpenSSL, um die beiden Dateien zu extrahieren.

    Tipp

    Kostenlose SSL-Zertifikate sind bei Anbietern wie Let's Encrypt erhältlich.

  • SSH-Konnektivität.

Konten

Ihre Harmony muss eine Rolle haben mit Administratorberechtigung. (Die Berechtigung „Agent installieren“ allein reicht nicht aus.)

Empfehlungen

Beim Einrichten Ihres API Gateway Host sollten Sie die empfohlenen Punkte beachten:

  • Geben Sie den Host nicht gemeinsam mit anderen Nicht-Systemanwendungen frei.

  • Konfigurieren Sie den Host für optimale Leistung.

  • Installieren Sie die folgenden zusätzlichen Pakete für Ihren Host:

    • Red Hat Enterprise Linux (RHEL): Wenn cloudbasiert, verwenden Sie einen Compute-Knoten mit den folgenden Paketgruppen:

      • Debugging-Tools.
      • Dienstprogramme zur Hardwareüberwachung.
      • Kompatibilitätsbibliotheken.
      • Entwicklungstools.
      • Sicherheitstools.

    • Debian, Ubuntu: Verwenden Sie eine Standardinstallation und wählen Sie die folgenden zusätzlichen Pakete aus:

      • OpenSSH.

  • Netzwerk: Öffnen Sie Port 443 (HTTPS). Sie können hierfür folgende Befehle verwenden:

    firewall-cmd --zone=public --add-port=443/tcp --permanent
firewall-cmd --reload

    ufw allow 443/tcp

Installieren und Konfigurieren eines privaten API Gateways

Um ein privates API Gateway zu installieren und zu konfigurieren, führen Sie diese Schritte mit einem Konto mit Root-Berechtigungen aus:

  1. Laden Sie eines der folgenden privaten API Gateway-Softwarepakete vom Harmony-Portal herunter Downloads Seite und kopieren Sie sie dann auf Ihren API -Gateway Host:

    • Linux RPM: Die .rpm Paketdatei zur Installation auf Red Hat oder Amazon Linux.

    • Linux Debian: Die .deb Paketdatei zur Installation unter Debian oder Ubuntu Linux.

  2. Führen Sie diese Befehle für Ihre Kombination aus Betriebssystem und Gateway-Version aus und ersetzen Sie x.x.x.x(.deb) oder x.x.x-x(.rpm) mit der heruntergeladenen Versionsnummer:

    yum update
yum install jitterbit-api-gateway-x.x.x-x.x86_64.rpm

    yum update
yum install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
yum install jitterbit-api-gateway-x.x.x-x.x86_64.rpm

    apt-get update
apt-get install libzzip-dev libyaml-dev
apt --fix-broken install
apt install python
dpkg --install jitterbit-api-gateway-x.x.x.x.amd64.deb

    apt-get update
apt-get -y install libgeoip-dev
apt --fix-broken install
ln -s /usr/bin/python2.7 /usr/bin/python
dpkg --install jitterbit-api-gateway-x.x.x.x.amd64.deb

    apt-get update
apt-get install libzzip-dev libyaml-dev libpcre3
apt --fix-broken install
dpkg --install jitterbit-api-gateway-x.x.x.x.amd64.deb

  3. Kopieren und benennen Sie Ihre Zertifikatsdateien mit den folgenden Befehlen:

    cp ca.crt /usr/local/openresty/nginx/ssl/nginx.crt
cp ca.key /usr/local/openresty/nginx/ssl/nginx.key

  4. Fügen Sie die Zertifikatsdateien zum Jitterbit Java KeyStore hinzu.

  5. Führen Sie den folgenden Befehl aus und beantworten Sie anschließend die Fragen:

    jitterbit-api-gateway-config

    Tipp

    Für Hilfe zum jitterbit-api-gateway-configBefehl, führen Sie es mit dem --help Option.

    Wichtige Hinweise

    • Die von Ihnen angegebenen Daten werden gespeichert im /usr/local/openresty/nginx/conf/onpremise/gatewayconfig.yaml Datei. In dieser Datei sind Ihr Harmony-Benutzername und-Passwort verschlüsselt, der Benutzername und das Passwort des Proxy-Servers jedoch nur Base64-kodiert. Stellen Sie sicher, dass diese Datei über die entsprechenden Berechtigungen verfügt, um zu verhindern, dass andere Benutzer diese Werte lesen.

    • Wenn Sie zum ersten Mal ein privates API Gateway mit Harmony-Anmeldeinformationen konfigurieren, wird in der Organisation automatisch ein neuer, separater API -Gateway-Benutzer mit einem unbefristeten Passwort und der Rolle„Administrator“ erstellt. Dieser Benutzer ist keiner Email Adresse zugeordnet, kann sich nicht beim Harmony-Portal anmelden und ist ausschließlich für das API Gateway zuständig. Die Anmeldeinformationen für diesen Benutzer werden dem gatewayconfig.yaml Datei.

    • Seit der API Gateway-Version 11.32 wird Ihnen bei einer Neukonfiguration des Gateways die folgende zusätzliche Frage gestellt:

      Would you like to generate a new Gateway credentials and overwrite existing ones? (y/N):

      Wenn Sie antworten N werden die bestehenden Benutzeranmeldeinformationen verwendet. Wenn Sie antworten Y, ein neuer Benutzer wird erstellt.

    • API Gateway-Benutzer werden in der Management Console Benutzerverwaltung angezeigt Seite im Formular <GatewayUser>_<orgID>_<ID> Wenn derselbe Benutzer das Gateway in derselben Organisation neu konfiguriert, wird dem Namen des Gateway-Benutzers ein Unterstrich und eine erhöhte Zahl angehängt, beispielsweise _1.

    Abstrakte Beispielausgabe 
    Jitterbit Private Gateway Configuration

Enter your Harmony user name:
Enter your Harmony password:
Are you an NA, EMEA or APAC customer (Enter one, NA, EMEA, or APAC):

Would you like to enable a proxy (Y/N)?
Enter your proxy server uri (e.g. http://192.168.1.100:808):
Enter your proxy username:
Enter your proxy password:

Connecting to Harmony...
NOTE: Default Jitterbit Services URL for NA customers is https://services.jitterbit.net/apis
NOTE: Default Jitterbit Services URL for EMEA customers is https://services.jitterbit.eu/apis
NOTE: Default Jitterbit Services URL for APAC customers is https://services.jitterbit.cc/apis

Enter Jitterbit Services URL (press enter for default):
Enter your Jitterbit Organization ID (press enter for default):
Creating Private Gateway User...

Here is the content of the DNS file that will be used for the API gateway:
The file is located here: /usr/local/openresty/nginx/conf/dnsservers.conf
resolver 127.0.1.1 valid=300s ipv6=off;

Here are the nameservers from /etc/resolve.conf:
nameserver 127.0.1.1

Would you like to use the resolv.conf DNS nameservers rather than the default nginx DNS servers? (Y/N)?

Would you like to manually add the DNS server the API gateway DNS configuration (Y/N)?
Please enter IP address or domain name. Press enter to finish:

Gateway Configuration file modified.

If you have an SSL Certificate, copy the SSL Certificate file to
    /usr/local/openresty/nginx/ssl/nginx.crt
and the SSL Certificate key file to
    /usr/local/openresty/nginx/ssl/nginx.key

Would you like the Gateway Server started? (Y/N)?
. . .

  6. Sie können jetzt über das private API Gateway auf die APIs Ihrer Organisation zugreifen.

    Notiz

    Zusätzlich zum Zugriff auf die APIs der Organisation über Ihre privaten API URLs können Sie weiterhin Jitterbit URLs verwenden. Um den Zugriff auf die Jitterbit URLs zu blockieren, kann ein Operation zunächst bestätigen, dass eine URL vom privaten API Gateway stammt, und andernfalls abbrechen. Das folgende Beispiel zeigt einen Test in der Region NA (für die Regionen EMEA und APAC ersetzen Sie jitterbit.eu oder jitterbit.cc je nach Bedarf):

    <trans>
if( index($jitterbit.api.request.headers.fulluri,'jitterbit.net') >0,
    $jitterbit.api.response = 'Public API gateway not permitted';
    CancelOperationChain($jitterbit.api.response);
)
</trans>

    Ein erfolgreicher Start eines privaten API Gateways sieht ungefähr wie folgt aus:

    Beispiel-Startup 
    . . .
nginx: [Alarm] [lua] startup.lua:0: ():
       ___ ___  ___  __   __    ___
   | |  |   |  |__  |__) |__) |  |
\__/ |  |   |  |___ |  \ |__) |  |
           API gateway

Version: x.x.x.x
Build Date: 20XX/XX/XX 00:00

Loading Libraries...
Libraries loaded successfully!

Loading configuration...
Configuration file:  /usr/local/openresty/nginx/conf/onpremise/gatewayconfig.yaml
Configuration file successfully loaded, parsing values...

************************************************************

InfluxDB output not configured.
Loggly output not configured.
ELK output not configured.

Configuration parsing successful!

Doing startup checks...

Checks completed, no errors.

------------------------------------------------------------

Jitterbit Services URL: https://services.jitterbit.net/apis
Gateway will login as: gatewayuser
Organization ID set to: 123456

Current Time: 20XX-XX-XX 00:00:00
Gateway Startup Successful!

Gateway server started

Testen des privaten API Gateways

Um das Gateway zu testen, führen Sie die folgenden Schritte aus:

  1. Richten Sie eine gültige API-Manager API ein in der mit dem privaten API Gateway verknüpften Organisation und einem API-Manager API Service-URL im Format https://JBExample123456.jitterbit.net/Development/1/customer.

  2. Testen Sie die API. Wenn sie korrekt funktioniert, testen Sie damit eine private API URL. Ersetzen Sie dazu die Jitterbit-Domäne und-Subdomänen durch Ihre eigene und behalten Sie dabei den gleichen Pfad bei. (Wenn es sich um eine Proxy-Konfiguration handelt, fügen Sie Folgendes hinzu: ?debug zur URL.)

    Beispiel

    Wenn Ihre Subdomain mysubdomain und Domäne ist example wird die Basis URL mysubdomain.example.com und Sie würden die API Dienst URL ändern https://JBExample123456.jitterbit.net/Development/1/customer zur privaten API URL https://mysubdomain.example.com/Development/1/customer So testen Sie eine private Proxy API URL https://mysubdomain.example.com/Development/1/customer, verwenden https://mysubdomain.example.com/Development/1/customer?debug. Bei Erfolg ist die Ausgabe Proxy enabled: PROXY_URI, Wo PROXY_URI ist der bei der Konfiguration angegebene Wert.

Selbsttest des privaten API Gateways

Um einen Gateway-Selbsttest durchzuführen, verwenden Sie die --test Option für die jitterbit-api-gateway-config-Befehl. Nach einer erfolgreichen Anmeldung werden automatisch mehrere Tests ausgeführt, um die korrekte Konfiguration sicherzustellen. Dazu gehören der Import eines integrierten Projekts und einer API sowie der Aufruf der API über das Gateway. (Für einen erfolgreichen Selbsttest muss in Ihrem Abonnement eine API URL verfügbar sein.)

Notiz

Die API wird mit aktivierter Option Nur SSL erstellt, sodass der Zugriff auf die Gateway URL nur über HTTPS getestet wird. Um den Zugriff über HTTP zu ermöglichen, können Sie die Option Nur SSL in der API Konfiguration deaktivieren, nachdem die Test API erstellt wurde.

Upgrade eines privaten API Gateways

Um ein privates API Gateway auf eine neuere Version zu aktualisieren, führen Sie die folgenden Schritte aus:

  1. Laden Sie die neueste Version der privaten API Gateway-Software über die Downloads Seite. (Bei Bedarf können ältere Versionen der Software vom Jitterbit-Support bezogen werden..)

    Tipp

    Das Upgrade eines privaten API Gateways auf eine neuere Version kann ohne Deinstallation der vorherigen Gateway-Version erfolgen, selbst beim Upgrade von einer 10.x- auf eine 11.x-Version.

  2. Erstellen Sie eine Sicherungskopie der Konfigurationsdatei des privaten API Gateways /usr/local/openresty/nginx/conf/onpremise/gatewayconfig.yaml.

  3. Erstellen Sie beim Upgrade von einem privaten API Gateway der Version 10.61 oder früher eine Sicherungskopie der SSL-Zertifikatsdateien. Die SSL-Zertifikatsdateien des privaten API Gateways befinden sich in diesen Verzeichnissen:

    /usr/local/openresty/nginx/ssl/nginx.crt
/usr/local/openresty/nginx/ssl/nginx.key

    Notiz

    Für das private API Gateway ab Version 10.62 ist es nicht erforderlich, eine Sicherungskopie der SSL-Zertifikatdateien zu erstellen oder diese zu kopieren. Diese Dateien bleiben bei einem Upgrade erhalten.

  4. Folgen Sie den install Schritte. (Die Befehle zum Upgrade eines privaten API Gateways sind dieselben wie für die Installation.)

  5. Kopieren Sie die Sicherungskopie der Konfigurationsdatei des privaten API Gateways und der SSL-Zertifikatsdateien (falls zutreffend) in die neue Installation des privaten API Gateways.

  6. (Optional) Führen Sie jitterbit-api-gateway-config, um zusätzliche Konfigurationsänderungen vorzunehmen. Sie können dies tun, wenn Sie neue Konfigurationseinstellungen verwenden, die in einer späteren Version des privaten API Gateways verfügbar sind.

  7. Führen Sie diesen Befehl aus, um das private API Gateway neu zu starten:

    jitterbit-api-gateway-config -s restart

Deinstallieren eines privaten API Gateways

Um ein privates API Gateway zu deinstallieren, führen Sie diese Befehle aus:

yum remove jitterbit-api-gateway
rm -rf /usr/local/jitterbit-api-gateway/
rm -rf /usr/local/openresty/
rm -rf /usr/local/hostedfiles/

apt-get remove jitterbit-api-gateway
apt-get purge jitterbit-api-gateway
rm -rf /usr/local/jitterbit-api-gateway/
rm -rf /usr/local/openresty/
rm -rf /usr/local/hostedfiles/

jitterbit-api-gateway-configBefehl

Der jitterbit-api-gateway-config Mit dem Befehl können Sie ein privates Jitterbit-API Gateway verwalten.

Zusammenfassung

jitterbit-api-gateway-config [OPTIONS]

Optionen

  • -h, --help: Hilfemeldung anzeigen und beenden.

  • -u USER, --user=USER: Jitterbit Harmony-Benutzername.

  • -p PASSWORD, --password=PASSWORD: Jitterbit Harmony Passwort.

  • -o ORGANIZATION_ID, --organizationId=ORGANIZATION_ID: Jitterbit Harmony-Organisations-ID.

  • -e ServiceUrl, --serviceUrl=ServiceUrl: URL der Jitterbit-Dienste.

  • -s COMMAND, --server=COMMAND: Gültige Werte für COMMAND:

    • start: Gateway starten.

    • stop: Gateway stoppen.

    • restart: Starten Sie das Gateway neu.

  • -d, --dns: DNS-Server interaktiv konfigurieren.

  • --proxyEnabled=true | false: Aktivieren (true) oder deaktivieren (false) einen Proxy.

  • --proxyUri=PROXY_URI: Proxyserver-URI.

  • --proxyUser=PROXY_USER: Proxyserver-Benutzername.

  • --proxyPassword=PROXY_PASSWORD: Proxyserver-Passwort.

  • -t, --test: Selbsttests durchführen.

  • --debug: debuggen Ausgabe für Selbsttests aktivieren.

  • --noColor: Terminaltextfarben deaktivieren.