Jitterbit API-Gateways
Übersicht
Wenn ein API-Manager-API aufgerufen wird, wird die Konnektivität zur API über ein API-Gateway ermöglicht. API-Gateways übernehmen die Sicherheitsaufgaben, die mit der Annahme und Verarbeitung von Aufrufen an ein 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 von Payloads Ihrer APIs.
Veröffentlichungszeitplan und Versionshinweise
Der Veröffentlichungszeitplan für das API-Gateway variiert je nach Gateway-Typ:
-
Das Cloud-API-Gateway wird automatisch gemäß dem Harmony-Veröffentlichungszeitplan aktualisiert.
-
Ein aktualisierter Installer für private API-Gateways wird nach Abschluss der Harmony-Veröffentlichung und des Sandbox-Cloud-Agent-Gruppen-Upgrades auf der Downloads Seite verfügbar.
-
Das Docker-Image für private API-Gateways wird nach Abschluss der Veröffentlichung der Produktions-Cloud-Agent-Gruppe in der Region Nordamerika (NA) auf Docker Hub verfügbar.
In den Harmony-Versionshinweisen wird jeder API-Gateway-Typ als separater Punkt in der Tabelle der Veröffentlichungsdaten am Anfang jeder Versionshinweis-Seite aufgeführt. Einzelne Versionshinweise sind unter der Überschrift API-Gateway aufgeführt, wobei relevante Anwendbarkeit auf bestimmte Gateway-Typen in den Versionshinweisen enthalten ist.
Anforderungsgrenzen und Fehlerbehandlung
API-Gateways implementieren Anforderungsgrenzen und geben diese HTTP-Fehlercodes für die folgenden Fehler zurück. Zusätzliche plattformweite Grenzen können je nach Gateway-Typ gelten.
| HTTP-Fehlercode | Beschreibung |
|---|---|
403 (Verboten) |
Das API-Gateway hat die Anfrage aufgrund unzureichender Berechtigungen oder eines Authentifizierungsfehlers abgelehnt. Dies tritt auf, wenn der Anfrage gültige Anmeldeinformationen fehlen, ein abgelöster 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 (Nicht Gefunden) |
Der angeforderte API-Endpunkt konnte nicht gefunden werden. Dies tritt typischerweise auf, wenn die Dienst-URL falsch ist, die API nicht veröffentlicht oder gelöscht wurde, das Umgebungs-URL-Präfix ungültig ist oder es eine Diskrepanz in der API-Version oder dem Dienststamm gibt, die in der Anfrage-URL angegeben ist. |
414 (URI Zu Groß) |
Die API-Dienst-URL überschreitet das Limit von 8.000 Zeichen. |
429 (Zu Viele Anfragen) |
Die Anfrage wird aufgrund von Ratenbegrenzung abgelehnt. Dies tritt auf, wenn die Anfrage das zulässige Kontingent an API-Aufrufen pro Minute der Organisation überschreitet, die Ratenlimits auf Umgebungsniveau verletzt, die Ratenlimits des Sicherheitsprofils überschreitet oder wenn die Organisation ihr monatliches Kontingent an API-Aufrufen aufgebraucht hat. |
Zusätzlich zu den oben genannten Grenzen setzt das von Jitterbit verwaltete Cloud-API-Gateway eine plattformweite Grenze von 200 API-Anfragen pro Minute und Organisation durch. Anfragen, die diesen Schwellenwert überschreiten, können von der Plattform drosselt werden. Diese Grenze gilt kollektiv für alle API-Typen, einschließlich benutzerdefinierter APIs, Proxy-APIs und OData-Anfragen. Diese Grenze gilt nicht für private API-Gateways, bei denen der Durchsatz durch die Kapazität des Host-Servers bestimmt wird.