Jitterbit API-Gateways

Übersicht

Wenn eine API Manager API aufgerufen wird, wird die Konnektivität zur API durch ein API-Gateway ermöglicht. API-Gateways handhaben die Sicherheitsaufgaben, die mit dem Akzeptieren und Verarbeiten von Aufrufen an eine API Manager API verbunden sind.

Es gibt zwei Arten von API-Gateways:

Cloud API-Gateways: Diese Gateways werden von Jitterbit gehostet und verwaltet.
Private API-Gateways: Diese Gateways werden von Ihnen installiert, gehostet und verwaltet. Sie bieten vollständige Kontrolle über die Autorisierung, das Routing, die Raten sowie die Speicherung und Verarbeitung der Nutzlast Ihrer APIs.

Veröffentlichungsplan und Versionshinweise

Der Veröffentlichungsplan für das API-Gateway variiert je nach Gateway-Typ:

Das Cloud API-Gateway wird automatisch gemäß dem Harmony-Veröffentlichungsplan aktualisiert.
Ein aktualisiertes Installationsprogramm für das Private API-Gateway wird auf der Seite Downloads nach Abschluss der Harmony-Veröffentlichung und des Sandbox Cloud Agent Group-Upgrades verfügbar.
Das Docker-Image des Private API-Gateways wird auf Docker Hub nach Abschluss der Production Cloud Agent Group-Veröffentlichung in der Region Nordamerika (NA) verfügbar.

In den Harmony-Versionshinweisen ist jeder API-Gateway-Typ als separater Posten in der Tabelle mit den Veröffentlichungsdaten oben auf jeder Seite mit Versionshinweisen aufgeführt. Einzelne Versionshinweise sind unter der Überschrift API-Gateway aufgelistet, wobei alle relevanten Anwendbarkeiten auf bestimmte Gateway-Typen in den Versionshinweisen enthalten sind.

Anfragegrenzwerte und Fehlerbehandlung

API-Gateways implementieren Anfragegrenzwerte und geben diese HTTP-Fehlercodes für die folgenden Fehler zurück. Je nach Gateway-Typ können zusätzliche Grenzwerte auf Plattformebene gelten.

HTTP-Fehlercode	Beschreibung
`403 (Forbidden)`	Das API-Gateway lehnte die Anfrage aufgrund unzureichender Berechtigungen oder eines Authentifizierungsfehlers ab. Dies tritt auf, wenn der Anfrage gültige Anmeldedaten fehlen, ein abgelaufener oder ungültiger API-Schlüssel verwendet wird, IP-Adressbeschränkungen verletzt werden oder versucht wird, auf eine API ohne ordnungsgemäße Autorisierung über das zugewiesene Sicherheitsprofil zuzugreifen.
`404 (Not Found)`	Der angeforderte API-Endpunkt konnte nicht gefunden werden. Dies tritt normalerweise auf, wenn die Service-URL falsch ist, die API nicht veröffentlicht oder gelöscht wurde, das URL-Präfix der Umgebung ungültig ist oder ein Konflikt in der API-Version oder dem in der Anfrage-URL angegebenen Service-Root besteht.
`414 (URI Too Large)`	Die API-Service-URL überschreitet das Limit von 8.000 Zeichen.
`429 (Too Many Requests)`	Die Anfrage wird aufgrund von Ratenbegrenzung abgelehnt. Dies tritt auf, wenn die Anfrage die zulässige Anzahl von API-Hits pro Minute der Organisation überschreitet, Ratenbegrenzungen auf Umgebungsebene verletzt, Ratenbegrenzungen des Sicherheitsprofils überschreitet oder wenn die Organisation ihre monatliche Zuteilung von API-Hits verbraucht hat.

Zusätzlich zu den oben genannten Limits erzwingt das von Jitterbit verwaltete Cloud-API-Gateway ein Limit auf Plattformebene von 200 API-Anfragen pro Minute pro Organisation. Anfragen, die diesen Schwellenwert überschreiten, können durch die Plattform ratenbegrenzt werden. Dieses Limit gilt kollektiv für alle API-Typen, einschließlich Custom APIs, Proxy APIs und OData-Anfragen. Dieses Limit gilt nicht für private API-Gateways, bei denen der Durchsatz durch die Kapazität des Host-Servers bestimmt wird.

Payload-Komprimierung

API Manager APIs unterstützen gzip-Komprimierung der Response-Payload. Um eine komprimierte Response anzufordern, fügen Sie den Request-Header Accept-Encoding: gzip in den API-Aufruf ein. Das API-Gateway gibt dann die Payload komprimiert mit gzip zurück und fügt den Response-Header Content-Encoding: gzip hinzu. Es wird nur gzip-Komprimierung unterstützt.