HTTP (Eingangsagent)

Vorlage wählen

Lädt eine Vorlage mit Voreinstellungen. Die Vorlagen erhalten Sie im Update-Center.

URL Adressen-Suffix

Legt das Suffix der Endpoint-URL fest. Beispiel: example.

Das Fragezeichen-Icon links zeigt den vorderen Teil der URL. Vorderer Teil und Suffix ergeben zusammen die Gesamt-URL. Den Aufbau beschreibt der Abschnitt „Schematischer Aufbau der HTTP-Adresse“.

API Variablen

Legt die Pfad-Parameter der REST-Schnittstelle fest. Ein Pfad-Parameter ist ein variabler Abschnitt der URL. Dieses Feld erscheint nur im Modus REST-WebService.

Zwischen zwei Slashes definieren Sie genau einen Pfad-Parameter. Ein Beispiel zeigt der Abschnitt „Pfad-Parameter auslesen“.

Erlaubte HTTP-Methoden

Legt fest, welche HTTP-Methoden der Eingangsagent annimmt. Das Verhalten je Methode beschreibt der Abschnitt „Request-Body, Profil-Verhalten und Profil-Eingangsdaten“.

'DELETE' liefert Daten

Steuert, ob das Profil den Body eines DELETE-Requests als Eingangsdaten verwendet. Die vollständige Fallunterscheidung zeigt die Tabelle im Abschnitt „Request-Body, Profil-Verhalten und Profil-Eingangsdaten“.

Asynchrone Rückmeldung

Erlaubt mehrere parallele Instanzen dieses Profils. Lobster sendet die Response sofort und nicht erst nach Ende des Profil-Jobs.

Diese Option funktioniert nur mit einer festen Antwort. Die Checkbox Profil darf nur in einer Instanz laufen darf für dieses Profil nicht gesetzt sein. Lobster arbeitet die Jobs dieses Profils dann in einer Thread Queue ab.

Für DMZ unsichtbar

Verbirgt diese Schnittstelle vor dem DMZ-Server. Der DMZ-Server leitet dann keine Requests an dieses Profil weiter.

HTTP-Schnittstelle, REST-WebService, SOAP-WebService

Legt den Modus des Eingangsagenten fest. Die Modi beschreibt der Abschnitt „Modi des HTTP-Eingangsagenten“.

Veröffentliche Schnittstelle (API Dokumentation)

Stellt eine Swagger-/OpenAPI-Schnittstellenbeschreibung bereit, im JSON- oder YAML-Format. Details beschreibt der Abschnitt „Schnittstellenbeschreibung veröffentlichen“.

Swagger Transformer Version

Legt fest, welche Version die Schnittstellenbeschreibung erzeugt. v1.0 (deprecated) ist veraltet. Verwenden Sie v2.0.

OpenAPI/Swagger App öffnen

Öffnet die OpenAPI/Swagger App in einem neuen Browser-Tab. Dort prüfen Sie die Schnittstellenbeschreibung und testen Requests.

Testdaten für OpenAPI/Swagger App

Öffnet einen Dialog mit allen hinterlegten Testdateien des Profils. Dieses Feld erscheint nur im Modus REST-WebService.

Für jede Datei wählen Sie eine HTTP-Methode aus Erlaubte HTTP-Methoden aus. Die Datei steht dann im grafischen Tool für diese Methode zur Verfügung. Dort wählen Sie die Datei für einen Request aus, zum Beispiel für POST.

Content-Type der Antwort

Legt den MIME-Type der Response fest.

Multipart FileKey

Legt den Namen des Multiparts fest, der die Hauptdaten enthält. Lobster sucht standardmäßig den Part mit dem Namen file.

 HINWEIS: Dieses Feld wirkt nur bei Multipart-Requests. Es wirkt nur dann, wenn kein Part mit dem Namen file existiert. Siehe auch den Abschnitt „HTTP-Multipart-Nachrichten handhaben“.

Akzeptiere leeren HTTP Body

Wertet einen leeren HTTP-Body nicht als Fehler, zum Beispiel bei POST. Lobster erstellt dann eine Dummy-Eingabedatei mit dem Inhalt body data.

Antwort senden durch

Legt die Antwort für den Erfolgsfall fest. Die drei Varianten beschreibt der Abschnitt „Antwort im Erfolgsfall festlegen“. Die Antwort im Fehlerfall legen Sie immer in Antwort bei Fehler fest.

Antwort bei Erfolg

Enthält den festen Response-Wert für Antwort senden durch. Einen Zeilenumbruch fügen Sie mit <br> ein.

Verfügbare Platzhalter: {--jobnr--} oder @VAR_JOBNR@ für die Job-Nummer, {--uuid--} oder @VAR_SYS_MESSAGE_ID@ für die Message-ID. Variablen der Phase 3 verwenden Sie mit {--@MYVAR@--} oder @MYVAR@. Dafür muss Phase 3 aktiv sein.

Antwort bei Fehler

Enthält die Antwort für den Fehlerfall. Sie gilt für beide Varianten in Antwort senden durch.

Mit dem Platzhalter {--Exception--} geben Sie eine aufgetretene Exception zurück. Wenn die Exception-Meldung einen Teilstring §...§ enthält, ersetzt Lobster den Platzhalter durch diesen Teilstring. Beispiel: Wenn Sie in Phase 3 die Funktion throw exception("§Sorry!§") aufrufen, ersetzt Lobster {--Exception--} durch Sorry!.

Alternative Platzhalter: {--FullStackTraceException--} für den vollen Stacktrace, {--ExceptionBase64--} für die Exception in Base64.

HTTP Fehler-Code

Legt den HTTP-Response-Status-Code für den Fehlerfall fest.

Rechts neben dem Feld finden Sie den Button Weitere HTTP Fehler-Codes. Darüber tragen Sie zusätzliche Codes ein. Jedem Code weisen Sie eine eigene Antwort bei Fehler zu. Diese Einträge verwendet die Funktion throw http exception().

WWW Authentication

Legt die Zugangskontrolle fest. Sie haben drei Optionen. Ohne: keine Zugangskontrolle. Mit Kanal: Zugangskontrolle über einen oder mehrere HTTP-Kanäle. Ohne Kanal: Zugangskontrolle über direkt angegebene Zugangsdaten.

Bei einer Zugangskontrolle wählen Sie zusätzlich die Authentication-Methode: BASIC, DIGEST, OAUTH2 oder SYSTEM. Den angemeldeten Benutzer lesen Sie über die System-Variable MSG_CALL_HTTP_AUTH_USER aus.

Bei SYSTEM verwendet Lobster die Einstellung forceDigestAuthentication aus der Konfigurationsdatei ./etc/startup.xml. Bei OAUTH2 geben Sie zusätzlich einen HTTP-Kanal mit OAUTH2-Konfiguration an. Vault-Passwörter beschreibt der Abschnitt Vault-Provider konfigurieren.

Benutzer

Enthält den Benutzernamen für die Zugangskontrolle. Dieses Feld erscheint nur bei der Option Ohne Kanal.

Kennwort

Enthält das Kennwort für die Zugangskontrolle. Dieses Feld erscheint nur bei der Option Ohne Kanal. Über das Schloss-Symbol verwenden Sie ein Vault-Passwort.

Pflicht-Parameter

Zugangskontrolle und Pflicht-Parameter liegen in zwei Tabs. Legt fest, welche Request-Parameter ein HTTP-Request mindestens enthalten muss. Details beschreiben die Abschnitte „Request-Ablauf“ und „Request-Parameter“.

☰-Menü rechts vom Feld URL Adressen-Suffix

Öffnet ein Menü für eigene Swagger-Dateien. Darüber legen Sie eine eigene Schnittstellenbeschreibung an, die Lobster statt der automatisch generierten verwendet. Siehe Abschnitt „Schnittstellenbeschreibung veröffentlichen“.

Feld URL Adressen-Suffix

example/

Feld API Variablen

{shop}/{petID}

HTTP-Request

https://<URL/IP Integration Server>/dw/request/example/myshop/0814/something

MSG_CALL_HTTP_REST_API_PATH_shop

myshop

MSG_CALL_HTTP_REST_API_PATH_petID

0814

MSG_CALL_HTTP_PATH_DATA

myshop/0814/something

MSG_CALL_HEADER_HTTP_URI

/example/myshop/0814/something

HTTP-Schnittstelle

Das ist der Standardmodus. Der Eingangsagent nimmt Requests über die URL aus URL Adressen-Suffix an, hier also https://localhost/dw/Request/example. Die Felder API Variablen und Testdaten für OpenAPI/Swagger App fehlen in diesem Modus.

REST-WebService

Der Eingangsagent arbeitet als REST-Schnittstelle. Er nimmt zusätzlich Requests mit einem angehängten Pfad an. Beispiel: Bei der URL https://localhost/dw/Request/example nimmt er auch https://localhost/dw/Request/example/orders an.

Das zusätzliche Suffix /orders speichert Lobster in der System-Variable MSG_CALL_HTTP_PATH_DATA. Im Übrigen verhält sich der Eingangsagent wie im Modus HTTP-Schnittstelle. Zusätzlich stehen die Felder API Variablen und Testdaten für OpenAPI/Swagger App zur Verfügung.

In diesem Modus erscheint ein weiterer Button. Er öffnet einen Dialog, in dem Sie über das Kontextmenü Beispiel-Response-Dateien hinterlegen. Diese Dateien zeigt das grafische Tool nur an, wenn dort die Checkbox Response Daten anzeigen gesetzt ist.

SOAP-WebService

Der Eingangsagent arbeitet als SOAP-WebService. Details beschreiben die Abschnitte Profil als SOAP-Webservice (statische Response) und Profil als SOAP-Webservice (dynamische Response).

Festen Wert

Lobster sendet den Wert aus dem Feld Antwort bei Erfolg.

'Eigene Klasse' oder 'Datenrückgabe' im Antwortweg des Profils

Verwenden Sie einen Antwortweg Eigene Klasse mit der Klasse PassBackDataResponse. Alternativ setzen Sie die Option Daten zurückliefern in einem Antwortweg HTTP oder Message. Siehe auch Abschnitt HTTP-Response-Kette.

Kein Rückgabewert

Lobster sendet eine leere Response mit dem Response-Status-Code 204.

<Protokoll>

http oder https. Siehe auch Abschnitt Hinzufügen eines HTTPS-Listeners.

<Server> und <Port>

DNS-Name oder IP-Adresse des Integration Servers, optional mit Portnummer. Verwenden Sie die Werte, die Sie für den HTTP-Listener oder den HTTPS-Listener konfiguriert haben. Die Standard-Ports 80 für HTTP und 443 für HTTPS können Sie weglassen.

Eine Firewall kann externe Zugriffe über Portforwarding vermitteln. Verwenden Sie in diesem Fall die Parameter des externen Anschlusses. Beim Zugriff über einen DMZ-Server gelten die externen Anschlüsse des DMZ-Servers.

<URL-Kontext>

Für ein Profil mit eventgesteuertem Eingangsagenten HTTP normalerweise /dw/request. Zum Triggern eines Profils mit zeitgesteuertem Eingangsagenten normalerweise /dw/trigger.

Die Standard-Einstellungen ändern Sie systemweit in der Konfigurationsdatei ./etc/startup.xml.

<URL-Suffix>

Der Wert aus dem Feld URL Adressen-Suffix.

<Query>

Zusätzliche Aufruf-Parameter. Aufbau: ?Name1=Wert1&Name2=Wert2

GET

Ein GET-Request hat normalerweise keine Body-Daten. Vorhandene Body-Daten ignoriert Lobster. Da ein Profil Eingangsdaten benötigt, erzeugt Lobster einen Dummy-String. Der Inhalt hängt von der Dokumentenart des Profils ab.

• XML: <body_data/>

• JSON: {"body": "data"}

• Alle anderen: body data

POST

Wenn der Request Body-Daten enthält, sind diese Daten die Eingangsdaten des Profils. Das ist der Normalfall.

Wenn der Request keine Body-Daten enthält, entscheidet die Checkbox Akzeptiere leeren HTTP Body:

• Checkbox gesetzt: Das Profil erhält den Dummy-String, wie bei GET.

• Checkbox nicht gesetzt: Lobster startet keinen Job. Das Profil liefert die Response Your request could not be processed due to empty body mit dem Response-Status-Code 500.

PUT

Wie POST.

HEAD

Wie GET.

DELETE

Wenn der Request keinen Body enthält, entscheidet die Checkbox 'DELETE' liefert Daten:

• Checkbox nicht gesetzt: Das Profil erhält den Dummy-String, wie bei GET.

• Checkbox gesetzt: Lobster startet keinen Job. Das Profil liefert die Response Your request could not be processed due to empty body mit dem Response-Status-Code 500.

Wenn der Request einen Body enthält, entscheidet dieselbe Checkbox:

• Checkbox nicht gesetzt: Das Profil erhält den Dummy-String, wie bei GET.

• Checkbox gesetzt: Die Body-Daten sind die Eingangsdaten des Profils.

PATCH

Wie POST.

Parameter-Name

Der Name des HTTP-Request-Parameters, der vorhanden sein muss. Sie können System-Konstanten verwenden.

Um mehrere Werte für einen Parameter zu erlauben, legen Sie den Parameter-Namen mehrfach an.

Wert

Erwarteter Wert des Parameters. Wenn Sie einen Wert eintragen, muss der Parameter im Request genau diesen Wert haben.

Mit dem Symbol * erlauben Sie beliebige Werte. Der Parameter muss dann nur vorhanden sein. Sie können System-Konstanten verwenden. Reguläre Ausdrücke geben Sie mit dem Präfix regex: oder regex2: an.

Das Profil wurde erfolgreich ausgeführt.

200

In Antwort senden durch ist Eigene Klasse gesetzt.

200. Diesen Wert überschreiben Sie mit der System-Variable VAR_RESPONSE_HTTP_HEADER_RESP_STATUS.

In Antwort senden durch ist Kein Rückgabewert gesetzt.

204

Während der Profil-Ausführung trat ein Fehler auf.

Der Wert aus HTTP Fehler-Code. Alternativ der Wert, den die Funktion throw http exception() setzt.

Die Option Asynchrone Rückmeldung ist gesetzt.

200, sobald Lobster das Profil erfolgreich angestoßen hat. Die Funktion throw http exception() kann den Response-Status dann nicht mehr verändern.

Zweiter Part

MSG_CALL_HTTP_MULTIPART1_NAME

MSG_CALL_HTTP_MULTIPART1_VALUE

Dritter Part

MSG_CALL_HTTP_MULTIPART2_NAME

MSG_CALL_HTTP_MULTIPART2_VALUE