API Typen im Jitterbit API-Manager
Übersicht
Im API-Manager können Sie drei Arten von APIs erstellen und veröffentlichen:
Jeder API -Typ interagiert innerhalb der Systemarchitektur auf einzigartige Weise mit Harmony, wie unten beschrieben.
Weitere Informationen zur Jitterbit-Sicherheit und-Systemarchitektur finden Sie im Whitepaper zur Jitterbit-Sicherheit und-Architektur.
Custom API
Benutzerdefinierte APIs stellen eine Harmony Operation zur Nutzung bereit. Eine Operation muss zuerst erstellt und in Harmony bereitgestellt werden und kann beliebig sein Integration Studio oder Design Studio Operation. Die vorhandene Operation wird dann während der Konfiguration der benutzerdefinierten API referenziert und von einem API Verbraucher aufgerufen und genutzt. Benutzerdefinierte APIs werden über Jitterbit-Agenten (entweder Cloud-Agent-Gruppen oder private Agenten).
Dieses Diagramm zeigt, wie sich eine benutzerdefinierte API in der Systemarchitektur verhält, wenn sie mit einem Cloud-Agent und einem Cloud API -Gateway bereitgestellt wird:
-
Ein API Verbraucher ruft die benutzerdefinierte API auf, die sich im Cloud-API Gateway befindet.
-
Die benutzerdefinierte API Anforderung wird über das Cloud-API Gateway an den Messaging-Dienst weitergeleitet, der Anforderungen für Agentengruppen weiterleitet.
-
Ein Cloud-Agent empfängt die Anfrage vom Messaging-Dienst.
-
Der Cloud-Agent verweist auf die benutzerdefinierte API Operation, die während der benutzerdefinierten API Konfiguration angegeben wurde. und löst die ausgeführte Operation aus.
-
Der Operation antwortet mit einer API Payload, die mit dem Antworttyp übereinstimmt, die während der benutzerdefinierten API -Konfiguration ausgewählt wurde.
-
Die API Payload wird vom Cloud-Agent zurück an den API Verbraucher geleitet.
Notiz
Sofern der durch den API Aufruf ausgelöste Operation nicht Temporärer Speicher verwendet verbleibt die API Payload nur zwei Tage lang auf dem Agenten.
-
Laufzeitstatusinformationen und Protokolle laufender Vorgänge werden an die Transaktionsprotokolldatenbank gesendet.
Notiz
Verbraucherdaten werden nicht in der Datenbank der Transaktionsprotokolle gespeichert, es sei denn, debuggen-Modus ist während der benutzerdefinierten API -Konfiguration aktiviert.
Informationen zum Konfigurieren einer benutzerdefinierten API finden Sie unter Custom API -Konfiguration.
OData Dienst
OData Dienste stellen eine Design Studio API Operation bereit zur Nutzung. Die API Operation muss zuerst erstellt und in Harmony bereitgestellt werden. Die vorhandene API Operation wird dann während der Konfiguration des OData Dienstes referenziert und von einem API Verbraucher aufgerufen und genutzt. OData Dienste werden über Jitterbit-Agenten (entweder Cloud-Agentengruppen geleitet oder private Agenten).
Dieses Diagramm zeigt, wie sich ein OData Dienst in der Systemarchitektur verhält, wenn er vor Ort mit einem privaten Agenten und einem privaten API -Gateway bereitgestellt wird:
-
Ein API Verbraucher ruft den OData-Dienst am privaten API Gateway auf.
-
Die OData-Serviceanforderung wird über das private API Gateway weitergeleitet.
-
Die Anfrage wird vom Nachrichtendienst empfangen, der die Anfragen an Agentengruppen weiterleitet.
-
Der private Agent empfängt die Anfrage vom Nachrichtendienst.
-
Der private Agent verweist auf die Operation der OData Service API in Harmony und löst die bereitgestellte Operation aus.
-
Der Operation antwortet mit einer API Payload, die vom privaten Agenten über das private API Gateway zurück zum API Verbraucher geleitet wird.
Notiz
Sofern der durch den API Aufruf ausgelöste Operation nicht Temporärer Speicher verwendet verbleibt die API Payload nur zwei Tage lang auf dem Agenten.
-
Laufzeitstatusinformationen und Protokolle laufender Vorgänge werden an die Transaktionsprotokolldatenbank auf dem privaten Agenten gesendet.
Notiz
Verbraucherdaten werden nicht in der Datenbank der Transaktionsprotokolle gespeichert, es sei denn, debuggen-Modus wird während der OData Dienstkonfiguration aktiviert.
-
Protokolle des privaten Agenten können optional mit der Transaktionsprotokolldatenbank innerhalb von Harmony synchronisiert werden.
Informationen zur Konfiguration eines OData Dienstes finden Sie unter OData-Dienstkonfiguration.
Proxy-API
Im Gegensatz zu benutzerdefinierten APIs oder OData Dienste, die einen Harmony Operation zur Nutzung bereitstellen, werden Proxy APIs mit einer vorhandenen API eines Drittpartei verwendet und nicht über Jitterbit-Agenten weitergeleitet. Die über den Proxy gesendete API muss für das Gateway zugänglich sein, das die API verarbeitet, entweder das Cloud API Gateway oder ein privates API Gateway:
-
Cloud-API Gateway: Wenn Sie das API Gateway verwenden, das Jitterbit auf Harmony hostet, muss die vorhandene API ö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 geproxte API zu gewähren, finden Sie unter Informationen zur Whitelist und navigieren Sie zu
https://services.jitterbitfür Ihre Region. -
Privates API Gateway: Bei Verwendung eines privaten API Gateways, muss die vorhandene API über das private API Gateway zugänglich sein.
Dieses Diagramm zeigt, wie sich eine Proxy-API in der Systemarchitektur verhält, wenn sie vom Cloud API Gateway verarbeitet wird:
-
Ein API Verbraucher ruft die Proxy-API im Cloud-API -Gateway auf.
-
Der Proxy API Aufruf wird über das Cloud-API -Gateway geleitet und an die als Proxy dienende Drittpartei API gesendet.
-
Die API Payload wird über das Cloud-API Gateway zurück an den API Verbraucher geleitet.
-
Die Drittpartei API antwortet mit einer API Payload, die über das Cloud-API Gateway zurück zum API Verbraucher geleitet wird.
-
Laufzeitstatusinformationen werden an die Datenbank der Transaktionsprotokolle gesendet.
Notiz
Verbraucherdaten werden nicht in der Datenbank der Transaktionsprotokolle gespeichert, es sei denn, debuggen-Modus ist während der Proxy-API Konfiguration aktiviert.
Informationen zum Konfigurieren einer Proxy-API finden Sie unter Proxy-API Konfiguration.