Zum Inhalt springen

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

✕

Veröffentlichen Sie einen Operation als API im Jitterbit Integration Studio

Einführung

Auf dieser Seite wird beschrieben, wie Sie eine benutzerdefinierte API konfigurieren und veröffentlichen (um eine Operation zur Nutzung freizugeben) aus Integration Studio heraus. Die Option Als API veröffentlichen ist über das Aktionsmenü einer Operation zugänglich.

Alternativ können benutzerdefinierte APIs über den API-Manager APIs erstellt werden Seite.

Notiz

Nach der Veröffentlichung zählt eine benutzerdefinierte API als API-URL zu Ihrem Harmony Abonnementkontingent.

Benutzerdefinierte APIs (veröffentlicht und Entwurf) werden an diesen Orten angezeigt:

  • Die APIs Seite des API-Manager.
  • Die Tab Ressourcen des Projektbereichs für das Integration Studio-Projekt, das mit der benutzerdefinierten API verknüpft ist.

Voraussetzungen

Um die Option Als API veröffentlichen im Aktionsmenü der Operation zu verwenden müssen diese Voraussetzungen erfüllt sein:

Konfigurieren der API

Nachdem Sie im Aktionsmenü der Operation auf die Option Als API veröffentlichen geklickt haben wird ein benutzerdefinierter API Konfigurationsdialog mit diesen Einstellungen geöffnet:

cs benutzerdefinierte API -Konfiguration

Notiz

Optionale Einstellungen wie Pfadparameter, Abfrage und Anforderungsheader können im API-Manager festgelegt werden (siehe Schritt 2: Diensttyp auswählen und Operationen zuweisen in Custom API).

  • API -Name: Geben Sie einen Namen für die API ein, der zur internen Identifikation verwendet werden soll. Standardmäßig wird dieses Feld mit dem Namen der Operation ausgefüllt.

  • 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 in Camel Case konvertierten Operation ausgefüllt. Leerzeichen und bestimmte Sonderzeichen sind in diesem Feld nicht zulässig. Die Verwendung anderer Sonderzeichen als Unterstriche (_) wird nicht empfohlen. Folgende Sonderzeichen sind zulässig:

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

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

  • Zusätzliche Einstellungen: Klicken Sie hier, um zusätzliche Einstellungen zu erweitern:

    zusätzliche Einstellungen

    • Umgebung: Dieses Feld ist auf die Umfeld des aktuell aufgerufenen Projekts eingestellt und kann nicht geändert werden.

    • Versionsnummer: Geben Sie eine optionale Version ein, die als Teil der Dienst-URL der API verwendet werden soll. Dieses Feld erlaubt maximal 50 Zeichen und keine Leerzeichen oder bestimmte Sonderzeichen. Die Verwendung von anderen Sonderzeichen als einem Punkt (.) oder ein Bindestrich (-) wird nicht empfohlen. Gängige Namenskonventionen umfassen inkrementelle Versionen, wie z. B. v1.0, v1.1, v1.2oder mithilfe eines Datums, an dem die API veröffentlicht wurde, wie etwa 2023-09-21.

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

      Notiz

      Diese Einstellung ist unabhängig von der Einstellung Operations-Timeout, die auf der Tab Optionen der Operation verfügbar ist. Einstellungen für das Operationstimeout werden für API-Manager APIs nicht verwendet, es sei denn, es wird ein privater Agent verwendet und der EnableAPITimeout Einstellung in der privaten Agent-Konfigurationsdatei ist aktiviert.

    • debuggen-Modus aktivieren bis: Aktivieren Sie den debuggen-Modus und geben Sie ein entsprechendes Datum und eine Uhrzeit ein, ab 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. Ist dieser Modus aktiviert, speichert das System den vollständigen Inhalt jeder API Anfrage und-Antwort bis zu 24 Stunden nach dem Empfang des API Aufrufs. Dies gilt für alle von der API ausgelösten Vorgänge.

    • Nur SSL: Diese Option ist standardmäßig ausgewählt und erfordert die Verwendung der SSL- Verschlüsselung (empfohlen).

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

    • Ausführliche Protokollierung aktivieren: Aktivieren Sie diese Option, um die ausführliche Protokollierung zu aktivieren. Ausführliche Protokolle für APIs enthalten Anforderungs- und Antwortdaten in jedem API Protokoll, um die Überwachung eingehender und ausgehender Daten zu unterstützen und das Debuggen zu erleichtern. Da hierbei große Protokolldateien entstehen können, ist die ausführliche Protokollierung standardmäßig deaktiviert.

  • Dienstname: Geben Sie einen Namen für den API Dienst ein. Standardmäßig ist dieses Feld auf den Namen der Operation eingestellt.

  • Projekt: Der Name des Projekts, auf das aktuell zugegriffen wird.

  • Operation: Der Name der Operation, die zur Verwendung freigegeben wird.

  • Methode: Wählen Sie eine der folgenden Methoden aus: ALL, CUSTOM, DELETE, GET, POST oder PUT als Anforderungsmethode für die ausgewählte Operation. Die Auswahl von ALL erstellt separate DELETE, GET, POST, Und PUT Anforderungsmethoden für die Operation (die CUSTOM Methode ist nicht enthalten).

    Notiz

    API -Dienste mit einem CUSTOM Für die Methode wird keine OpenAPI-Dokumentation über den Portal Manager generiert-Seite aufgrund einer Einschränkung der OpenAPI-Spezifikation.

  • Antworttyp: Wählen Sie zwischen Endziel, Systemvariable oder Keine Antwort:

    • Endziel: Die API Antwort ist das Endziel der Operation. Wenn dieser Antworttyp ausgewählt ist, muss die Operation Folgendes haben (als Endziel der Operation): an Integration Studio API -Antwortaktivität. Wenn ein anderes endgültiges Ziel verwendet wird, ist die API Antwort leer.

    • Systemvariable: Die API Antwort wird in der Operation in einer Jitterbit-Variable festgelegt. Wenn dieser Antworttyp ausgewählt ist, muss die Operation (als Teil einer Operation) ein Script enthalten, das die Jitterbit-Variable jitterbit.api.response entspricht der Antwort, die die API zurückgeben soll. Wenn diese Variable nicht festgelegt ist, ist die API Antwort leer.

    • Keine Antwort: Die API -Antwort ist leer. Wenn die Anforderung zum Ausführen der ausgewählten Operation akzeptiert wird, gibt die API sofort eine leere Antwort mit dem HTTP-Code 202 zurück.

  • Benutzerrollen: Wählen Sie über das Menü die Organisationsrollen aus, deren Mitglieder über die unten aufgeführten API-Manager Seiten Zugriff auf die API haben. Zur Auswahl stehen die Rollen, die auf der Seite Benutzerverwaltung der Management Console definiert sind und standardmäßig ausgewählt sind.

    Dies bestimmt den Zugriff auf diese spezielle API von diesen Seiten aus:

    Zugriff auf die Sicherheitsprofile und der Zugriff auf die API bleiben von dieser Auswahl unberührt. (Der Zugriff auf die API wird durch Sicherheitsprofile gesteuert.)

    Definierte Benutzerrollen mit der Berechtigung Admin haben immer vollen Zugriff auf alle APIs und können daher nicht aus der Auswahl gelöscht werden. (Im oben gezeigten Beispiel Screenshot kann die Rolle Administrator daher nicht gelöscht werden.)

  • Sicherheitsprofile: Wählen Sie die Methode zum Bereitstellen eines Sicherheitsprofils aus, um den Zugriff für die Nutzung der API einzuschränken (optional):

    • Vorhandenes Profil verwenden: Wenn diese Option ausgewählt ist, verwenden Sie das Menü Profil, um ein vorhandenes Sicherheitsprofil auszuwählen.

    • Neues Profil erstellen: Wenn diese Option ausgewählt ist, werden zusätzliche Felder zur Konfiguration eines neuen Sicherheitsprofils verfügbar (siehe Sicherheitsprofilkonfiguration):

      Neues Profil erstellen

  • Profil: Sichtbar, wenn Vorhandenes Profil verwenden ausgewählt ist. Verwenden Sie das Menü, um ein vorhandenes Sicherheitsprofil auszuwählen und den Zugriff für die Nutzung der API einzuschränken.

  • Veröffentlichen: Speichert die API im Status Veröffentlicht. Die API ist innerhalb von fünf Minuten verfügbar. Eine veröffentlichte API zählt als API-URL zu Ihrem Harmony Abonnement. Sie können über den API-Manager APIs auf die veröffentlichte API zugreifen Seite.

  • Entwurf speichern: Speichert die API im Status Entwurf und ist über den API-Manager APIs zugänglich. Seite. Ein API Entwurf zählt nicht als API-URL zu Ihrem Harmony Abonnementkontingent. Sie können die Konfiguration des API Entwurfs über den API-Manager APIs aufrufen und abschließen Seite.

  • Abbrechen: Schließt den Dialog ohne zu speichern.

Wichtig

Standardmäßig werden erfolgreiche Vorgänge, die für eine benutzerdefinierte API konfiguriert sind, sind nicht in den Operation EnableLogging=true im [APIoperation] Abschnitt der privaten Agentenkonfigurationsdatei.

Nicht erfolgreiche Vorgänge werden in die Operation enthalten, sofern nicht eine dieser Einstellungen aktiviert ist:

  • Cloud-Agenten: Für API Operationen auf einem Cloud-Agenten Operation debuggen Protokollierung muss für die Operation aktiviert sein.
  • Private Agenten: Für API Operationen auf einem privaten Agenten muss entweder Operation debuggen Protokollierung muss für den Operation aktiviert sein oder Sie müssen aufgenommen, unabhängig davon, ob die oben genannten Einstellungen aktiviert sind oder nicht.