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

Einführung

Auf dieser Seite wird beschrieben, wie eine benutzerdefinierte API konfiguriert und veröffentlicht wird (um eine Operation für den Verbrauch verfügbar zu machen) von innen Integration Studio. Die Option Als API veröffentlichen ist über das Aktionsmenü einer Operation zugänglich.

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

Benutzerdefinierte APIs (veröffentlicht und im Entwurfsstadium) werden an diesen Speicherorten angezeigt:

• Die Meine APIs Seite des API-Manager.
• Die Tab Ressourcen des Projektfensters für die 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 folgende Voraussetzungen erfüllt sein:

• Die Organisation, auf die zugegriffen wird, muss über ein Abonnement für API-Manager verfügen und verfügen über die entsprechenden Rolle und Umfeld. Informationen zum Hinzufügen von API-Manager zu Ihrer Lizenz erhalten Sie von Ihrem Customer Success Manager (CSM).

• Die Operation darf keine nicht bereitgestellten Änderungen aufweisen.

Konfigurieren der API

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

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

• Service-Stamm: 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. In diesem Feld sind keine Leerzeichen oder bestimmte Sonderzeichen zulässig. Die Verwendung anderer Sonderzeichen als Unterstriche (_) wird nicht empfohlen. Diese Sonderzeichen sind erlaubt:

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

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

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

  • 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 anderer Sonderzeichen als eines Punktes (.) oder ein Bindestrich (-) wird nicht empfohlen. Gängige Namenskonventionen umfassen inkrementelle Versionen, wie z. B. v1.0, v1.1, v1.2 oder 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 aktivieren bis: Wählen Sie diese Option, um den debuggen zu aktivieren und ein entsprechendes Datum und eine entsprechende Uhrzeit einzugeben, zu denen der debuggen deaktiviert wird. Die maximale Aktivierungsdauer beträgt zwei Wochen. Der Debugmodus ermöglicht die vollständige Nachverfolgung aller über die Service-URL der API empfangenen Anfragen. Wenn diese Option aktiviert ist, behält das System den vollständigen Inhalt jeder API -Anfrage und-Antwort bis zu 24 Stunden ab dem Zeitpunkt des Empfangs des API Aufrufs bei und 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ührliches Protokollieren aktivieren: Wählen Sie diese Option, um das ausführliche Protokollieren zu aktivieren. Ausführliche Protokolle für APIs enthalten Anforderungs- und Antwortdaten in jedem API -Protokoll, um eingehende und ausgehende Daten zu überwachen und das Debuggen zu erleichtern. Da dadurch große Protokolldateien erstellt werden 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. Wenn Sie ALL auswählen, werden separate DELETE, GET, POST, Und PUT Anforderungsmethoden für die Operation (die CUSTOM Methode ist nicht enthalten).

  Notiz

  API Dienste mit einem CUSTOM-Methode verfügt nicht über eine OpenAPI-Dokumentation, die über den Portal Manager generiert wird 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 haben, das die Jitterbit-Variable festlegt 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: Verwenden Sie das Menü, um die Organisationsrollen auszuwählen, deren Mitglieder auf den unten aufgeführten API-Manager Seiten Zugriff auf die API haben. Die zur Auswahl stehenden Rollen sind diejenigen, 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:

  • Meine APIs
  • Portal Manager, einschließlich der Erstellung von API Dokumentation
  • Portal
  • API Protokolle
  • Analyse

  Zugriff auf die Sicherheitsprofile-Seite und der Zugriff auf die API sind von dieser Auswahl nicht betroffen. (Der Zugriff auf eine API wird durch Sicherheitsprofile gesteuert.)

  Alle definierten 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 aus diesem Grund nicht gelöscht werden.)

• Profil: Verwenden Sie optional das Menü, um ein vorhandenes Sicherheitsprofil auszuwählen und den Zugriff für die Nutzung der API einzuschränken.

  Notiz

  Wenn für die aktuell aufgerufene Umfeld keine vorhandenen Sicherheitsprofile konfiguriert sind, können Sie eines im API-Manager konfigurieren. Anweisungen finden Sie unter Konfiguration des Sicherheitsprofils.

• Veröffentlichen: Speichert die API im Status Veröffentlicht. Die API ist live und innerhalb von fünf Minuten zugänglich. Eine veröffentlichte API zählt als API-URL für Ihr Harmony Abonnementkontingent. Sie können über den API-Manager Meine APIs auf die veröffentlichte API zugreifen. Seite.

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

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