Eigenschaften von HTTP-Clients

Geben Sie die URL-Basisadresse ein, auf die Sie zugreifen möchten.

Beispiel: https://www.example.com/v1.0/

Der zweite Teil der URL muss im Parameter Path (Pfad) in der Konfiguration des HTTP-Client-Datensatzes festgelegt werden.

Sie können auch unter Verwendung der Syntax der Data-Shaping-Abfragesprache einen Platzhalter festlegen, um einige Teile dynamisch mit dem aus dem eingehenden Datensatz extrahierten Wert zu füllen. Beispiel:

Base URL (Basis-URL) = "https://{.input.job_url}" und Path (Pfad) = "{.input.job_url_path}"

• No authentication (Keine Authentifizierung): Für den Zugriff auf den Server wird keine Authentifizierung angefordert.
• Basic (Basis): Ein Benutzername und ein Passwort müssen eingegeben werden (siehe die entsprechende Dokumentation).
• Digest: Ein Benutzername und ein Passwort müssen eingegeben werden (siehe die entsprechende Dokumentation).
• Bearer Token: Ein rohes Zugriffstoken muss angegeben werden. Das Token wird folgendermaßen in den Header des HTTP-Requests aufgenommen: Authorization: Bearer <your token> (Autorisierung: Bearer <Ihr Token>).
• NTLM: Ein Benutzername (dieser muss einen Domänennamen enthalten) und ein Passwort müssen eingegeben werden (siehe die entsprechende Dokumentation).
• API Key (API-Key): Bietet Flexibilität bei der Übergabe eines API-Key-Tokens an den Server, d. h. Sie können festlegen, wie es übergeben werden soll, und können dazu den entsprechenden Namen sowie ein Präfix eingeben:
  • Destination (Ziel): Wählen Sie aus, wo das Token festgelegt werden soll: Entweder in einem HTTP-Header oder in einem HTTP-Abfrageparameter mit dem angegebenen Namen (Letzteres wird nicht empfohlen, da das Token in diesem Fall unter Umständen in den Logs angezeigt wird).
  • Name: Geben Sie den Namen des Headers oder Abfrageparameters ein.
  • Prefix (Präfix) (optional): Geben Sie das Präfix ein, das vor dem Token hinzugefügt werden soll (nur wenn Destination (Ziel) auf Request header (Request-Header) eingestellt ist).
  • Token: Geben Sie das Authentifizierungstoken ein.
• OAuth 2.0 verwaltet automatisch das Abrufen und Erneuern des Zugriffstokens auf dem OAuth-Server und übergibt dieses dann an den Zielendpunkt als Bearer Token:
  • Flow: Der OAuth-Flow, den Sie ausführen möchten. Zurzeit wird nur der Flow Client Credentials (Client-Anmeldedaten) unterstützt.
  • Authentication mode (Authentifizierungsmodus): Für alle unterstützten Authentifizierungsmodi werden die Parameter für Flow und Anwendungsbereich im Body im Format 'application/x-www-form-urlencoded' mit den Schlüsseln 'grant_type=xxx&scope=xxxx' festgelegt.
  • Token endpoint (Token-Endpunkt):
  • Geben Sie das Authentifizierungstoken im Format 'oauth2/mydomain.com/token' ein.
  • Client ID (Client-ID) und Client secret (Client Secret): Geben Sie die Client-ID und das Client Secret ein.
  • Additional parameters (Weitere Parameter): Geben Sie die weiteren Attribute ein, die hinzugefügt werden sollen, beispielsweise das Attribut scope.

Geben Sie die URL-Basisadresse ein, auf die Sie zugreifen möchten.

Beispiel: https://www.example.com/v1.0/

Der zweite Teil der URL muss im Parameter Path (Pfad) in der Konfiguration des HTTP-Client-Datensatzes festgelegt werden.

Aktivieren Sie diese Option, wenn die Verbindung zwischen Client und Server über einen HTTP- oder SOCKS-Proxy hergestellt werden soll:

• Proxy type (Proxy-Typ): Wählen Sie den Typ des Proxy aus, den Sie verwenden möchten. HTTP-Proxys unterstützen die Basisauthentifizierung (Basic Authentication).
• Proxy host (Proxy-Host) und Proxy port (Proxy-Port): Geben Sie Adresse und Port des Proxy ein.
• Proxy login (Proxy-Anmeldename) und Proxy password (Proxy-Passwort) (nur HTTP): Geben Sie die für eine Authentifizierung beim Proxy benötigten Anmeldedaten ein.

• Anfängliches Backoff (ms): Geben Sie die Wartedauer in Millisekunden vor dem ersten Wiederholungsversuch eines HTTP-Aufrufs ein.
• Backoff-Faktor: Wenn ein Versuch fehlschlägt, wird die Wartedauer mit diesem Faktor multipliziert, um die Verzögerung zwischen den einzelnen Aufrufen zu erhöhen. Wenn der Faktor 1 ist, sind alle Verzögerungen gleich.
• Max. Anzahl Wiederholungen: Geben Sie die maximale Anzahl Wiederholungsversuche für eine einzelne HTTP-Abfrage ein. Der anfängliche Aufruf wird bei dieser Anzahl nicht mitgezählt.

Beispiel für die folgende Konfiguration:

Anfängliches Backoff: 300 ms, Backoff-Faktor: 2 und Max. Anzahl Wiederholungen: 4

Der HTTP Client-Konnektor führt zunächst einen GET-Vorgang auf dem Server durch (erster Aufruf). Ein Fehler wegen Verbindungs-Timeout wird zurückgegeben, der Wiederholungsmechanismus wird aktiviert und der Konnektor wartet 300 Millisekunden. Dann wird ein zweiter Versuch unternommen (erste Wiederholung). Eine HTTP-Antwort 503 wird zurückgegeben, die Wartedauer wird mit 2 multipliziert, also wartet der Konnektor 600 Millisekunden lang. Ein dritter Versuch wird unternommen (zweite Wiederholung). Ein interner Serverfehler 500 wird zurückgegeben, die Wartedauer wird mit 2 multipliziert, also wartet der Konnektor 1200 Millisekunden lang. Ein vierter Versuch wird unternommen (dritte Wiederholung), und dieses Mal ist er erfolgreich. Es wird kein weiterer Versuch unternommen, und die Antwort wird zurückgegeben.

• Batch - wenn die HTTP-Abfrage einmal ausgeführt werden soll. Die Pipeline, die diesen Datensatz verwendet, muss eine Batch-Pipeline sein.
• Streaming - wenn die HTTP-Abfrage alle N Millisekunden in einer Streaming-Pipeline ausgeführt werden soll. Die Pipeline, die diesen Datensatz verwendet, muss eine Streaming-Pipeline sein. Darüber hinaus können Sie im Feld Min poll interval (ms) (Min. Abfrageintervall (ms)) des Quelldatensatzes das Abfrageintervall in Millisekunden festlegen.

Geben Sie den zweiten Teil der URL ein, die Sie zuvor in der Konfiguration der Verbindung festgelegt haben, für die der Datensatz erstellt werden soll. Die Verkettung beider Teile verweist dann auf die Ressource, die für den Datensatz als Ziel fungiert.

Die Werte von Base URL (Basis-URL) (Verbindung) und Path (Pfad) (Datensatz) werden miteinander verknüpft, nach Bedarf wird das Zeichen / hinzugefügt.

Sie können auch unter Verwendung der Syntax der Data-Shaping-Abfragesprache einen Platzhalter festlegen, um einige Teile dynamisch mit dem aus dem eingehenden Datensatz extrahierten Wert zu füllen. Beispiel:

Base URL (Basis-URL) = "https://{.input.job_url}" und Path (Pfad) = "{.input.job_url_path}"

Aktivieren Sie diese Option, um zusätzliche Parameter anzugeben, die zur Vervollständigung der Basis-URL bzw. des Pfads in Form von Name/Wert-Paaren erforderlich sind.

Beispiel:

Basis-URL = https://www.example.com

Pfad = /{api_version}

Parametername = api_version

Parameterwert = v1.0

• Name: Geben Sie den Namen des Parameters ein.
• Value (Wert): Geben Sie den Wert des Parameters ein. Dabei kann es sich um einen statischen Wert wie UUID-1234567, einen aus dem eingehenden Datensatz extrahierten Wert wie {.input.user.id} oder um eine Kombination aus beidem wie UUID-{.input.user.id} handeln.

Beispiel:

Name des Abfrageparameters = entityId

Wert des Abfrageparameters = UUID-1234567

• Name: Geben Sie den Namen des Headers ein.
• Value (Wert): Geben Sie den Wert des Headers ein. Dabei kann es sich um einen statischen Wert wie text/html; charset=utf-8, einen aus dem eingehenden Datensatz extrahierten Wert wie {.input.meta.content} oder um eine Kombination aus beidem wie text/{.input.document.format}; charset={.input.document.charset} handeln.
• Query (Abfrage): Wählen Sie die Abfrage aus, auf die diese Header-Konfiguration angewendet werden soll.

Beispiel:

Header-Name = Content-Type

Header-Wert = text/html; charset=utf-8

Abfrage = Main

• TEXT: Geben Sie den Inhalt (Body) der Nachricht als Klartext ein. Sie können unter Verwendung der Syntax der Data-Shaping-Abfragesprache einen Platzhalter festlegen, um einige Teile dynamisch mit dem aus dem eingehenden Datensatz extrahierten Wert zu füllen. Beispiel:

  id={.input.user.id}
  name={.input.user.name}

• JSON: Geben Sie den Inhalt der Nachricht im JSON-Format ein. Sie können unter Verwendung der Syntax der Data-Shaping-Abfragesprache einen Platzhalter festlegen, um einige Teile dynamisch mit dem aus dem eingehenden Datensatz extrahierten Wert zu füllen. Beispiel:

  {
      "id": "{.input.user.id}",
      "name": "{.input.user.name}",
      "age": {.input.user.age},
  }

• XML: Geben Sie den Inhalt der Nachricht im XML-Format ein. Sie können unter Verwendung der Syntax der Data-Shaping-Abfragesprache einen Platzhalter festlegen, um einige Teile dynamisch mit dem aus dem eingehenden Datensatz extrahierten Wert zu füllen. Beispiel:

  <user>
     <id>{.input.user.id}</id>
     <name>{.input.user.name}</name>
     <age>{.input.user.age}</age>
  </user>

• Form data (Formulardaten): Erstellen Sie den Nachrichteninhalt mithilfe eines mehrteiligen Formulars mit Attributname/Wert-Paaren. Sie können unter Verwendung der Syntax der Data-Shaping-Abfragesprache einen Platzhalter festlegen, um einige Teile dynamisch mit dem aus dem eingehenden Datensatz extrahierten Wert zu füllen.
• X_WWW_FORM_URLENCODED: Erstellen Sie den Nachrichteninhalt mithilfe eines URL-kodierten Formulars mit Attributname/Wert-Paaren. Sie können unter Verwendung der Syntax der Data-Shaping-Abfragesprache einen Platzhalter festlegen, um einige Teile dynamisch mit dem aus dem eingehenden Datensatz extrahierten Wert zu füllen.

• TEXT: Wählen Sie dieses Format aus, wenn eine Nachricht in Klartext zurückgegeben werden soll. In diesem Fall wird die Antwort-Payload nicht geparst und es können weder Teile daraus extrahiert noch {.response...}-Platzhalter in den Parametern Output key/value pair (Schlüssel/Wert-Paar ausgeben) verwendet werden.
• JSON: Wählen Sie dieses Format aus, wenn die empfangene Antwort das JSON-Format aufweisen soll. In diesem Fall wird die Payload in ordnungsgemäß geparste JSON-Datensätze umgewandelt.

(Nur verfügbar, wenn der Antwort-Body das JSON- oder XML-Format aufweist.)

Wenn der Antwort-Body in das JSON- oder XML-Format geparst wird, besteht die Möglichkeit, nur einen Teil der Antwort-Payload zurückzugeben. Zur Extraktion des Werts wird die Syntax der Data-Shaping-Abfragesprache verwendet. Wenn ein Array erkannt wird, werden die einzelnen Elemente nacheinander zurückgegeben.

• Body: Wenn Answer body format (Format des Antwort-Bodys) auf TEXT eingestellt ist, wird ein Datensatz mit einem Zeichenfolgenattribut (String) namens body generiert und die gesamte Payload wird in den Body kopiert.

  Wenn Answer body format (Format des Antwort-Bodys) auf JSON eingestellt ist, wird ein Datensatz generiert, der der hierarchischen Struktur des geparsten Dokuments entspricht.

• Status, headers and body (Status, Header und Body): Es wird ein Datensatz mit dem Attribut status (vom Typ Ganzzahl/Integer) generiert, das den HTTP-Statuscode enthält, mit dem Attribut headers, das einem Datensatz mit allen Antwort-Headern in Form verschachtelter Attribute entspricht, und dem Attribut body, bei dem es sich entweder um eine einfache Zeichenfolge (String) mit der gesamten Payload als Text handelt (Answer body format (Format des Antwort-Bodys) ist TEXT) oder um ein hierarchisches Objekt, das dem geparsten Dokument entspricht.

• Name: Geben Sie den Namen des auszugebenden Attributs ein.
• Value (Wert): Geben Sie den Wert des Attributs ein. Hierbei kann es sich um einen statischen Wert, einen aus dem eingehenden Datensatz extrahierten Wert oder um das Ergebnis der aktuellen HTTP-Abfrage handeln. Der Wert des Eingabedatensatzes oder die Antwort auf die aktuelle HTTP-Abfrage wird anhand des zugehörigen Präfixes identifiziert:
  • {.input}: Selektor für den Eingabedatensatz
  • {.response}: Selektor für die Antwort

Beispiel:

Name = id

Wert = {.response.user.id}

• Maximum number of redirects (Max. Anzahl Weiterleitungen): Legen Sie die maximale Anzahl der Weiterleitungen fest, die der Konnektor unterstützen soll. Wenn mehr Weiterleitungen als die konfigurierte Anzahl vorhanden sind, wird die letzte Weiterleitung als Ergebnis der Abfrage zurückgegeben.
• Redirect only on same host (Nur auf gleichem Host weiterleiten): Aktivieren Sie diese Option, wenn nur dann Weiterleitungen durchgeführt werden sollen, wenn derselbe Host verwendet wird.

• Preset (Voreinstellung): Wählen Sie die vordefinierte Konfiguration für die beliebtesten Dienste aus, die eine Paginierung unterstützen. Klicken Sie nach der Auswahl auf Load selected preset (Ausgewählte Voreinstellung laden), um das Paginierungsformular für die ausgewählte Umgebung zu aktualisieren.

  Weitere Informationen finden Sie in der Box-, JIRA- und OData-Dokumentation.

• Pagination strategy (Paginierungsstrategie): Die in dem von Ihnen abgefragten HTTP-Dienst implementierte Paginierungsstrategie. Offset/limit (Offset/Begrenzung) ist momentan die einzige unterstützte Strategie.
• Location (Speicherpfad): Geben Sie an, wo die Offset- und Begrenzungsparameter eingestellt sind. Entweder in Query parameters (Abfrageparameter) oder in Headers (Header).
• Name of the offset (Name des Offsets): Geben Sie den Namen des Parameters ein, der als Offset verwendet werden soll.
• Value of the offset (Wert des Offsets): Legen Sie den Ausgangswert für das Offset fest. Geben Sie 0 ein, um mit dem allerersten Einstellwert zu beginnen.

  Sie können diesen Wert aus dem eingehenden Datensatz unter Verwendung der Syntax der Sprache für die Data-Shaping-Auswahl abrufen.

  Beispiel: {.input.last_page_info.offset} (Eingabe.Infos_letzte_Seite.Offset)

• Name of the limit (Name der Grenze): Geben Sie den Namen des Parameters ein, der zur Festlegung der maximalen Anzahl an pro Seite zurückgegebenen Elementen verwendet werden soll.
• Value of the limit (Wert der Grenze): Legen Sie die maximale Anzahl der auf einer Seite zurückgegebenen Elemente fest. Die Paginierung wird angehalten, sobald eine Seite mit 0 Elementen zurückgegeben wird.
• Path to elements (Pfad der Elemente): Legen Sie den Pfad des JSON-Arrays fest, das die zurückgegebenen Elemente enthält. Es muss sich um ein JSON-Array handeln. Offset/limit (Offset/Begrenzung) zählt die Anzahl der Elemente in diesem Array und setzt die Paginierung fort, bis keine Elemente mehr vorhanden sind. Dann wird die Paginierung angehalten. Wenn die Paginierung Offset/limit (Offset/Begrenzung) aktiviert und dieser Parameter eingestellt wird, fungiert er als Stamm für Extract a sub-part of the response (Teil der Antwort extrahieren) in der Main (Haupt)-Konfiguration.

  Beispiel:

  Wenn Sie die Paginierung JIRA/search (Suchen) auswählen, werden Fehler standardmäßig im Array .issues zurückgegeben, folglich müssen Sie diesen Wert in Path to elements (Pfad der Elemente) eingeben. Wenn jedoch nur die Jira-Schlüssel zurückgegeben werden sollen, legen Sie .key (.Schlüssel) in Extract a sub-part of the response (Teil der Antwort extrahieren) fest. In diesem Fall werden Schlüssel zurückgegeben, selbst wenn key (Schlüssel) ein Attributder in issues (Fehler) vorhandenen Elemente ist.

• Normalize attributes (Attribute normalisieren): Damit können Sie einen Wert in den erwarteten Datentyp konvertieren.
• Normalize arrays (Arrays normalisieren): Damit können Sie für einige Elemente eines JSON-Arrays einen Filter anwenden.

  Beispiel:

  Falls Sie die Komponente konfigurieren, um dieses JSON-Dokument abzurufen, werden diese JSON-Inkonsistenzen in der Jobausführungskonsole zurückgegeben:

  Some JSON inconsistencies has been identified:
                                      .users.*.addresses is not consistently present in all objects.
                                      .users.*.active is not consistently present in all objects.
                                      .users.*.email is not consistently present in all objects.
                                      .users.*.addresses is an array that contains items of several types: STRING, OBJECT.
                                      .users.*.addresses.*.country is not consistently present in all objects.
                                      .users.*.addresses.*.street is not consistently present in all objects.
                                      .users.*.addresses.*.zipcode is found with varying types: STRING, INT.
                                      Please, have a look to advanced settings JSON normalization to fix it.

  Um dies zu verhindern, können Sie beispielsweise die Option Normalize attributes (Attribute normalisieren), um das Attribut mit dem Pfad .users.*.addresses als ARRAY-Typ und das Attribut mit dem Pfad users.*.addresses.*.zipcode als INT-Typ zu übergeben, auch wenn einige zurückgegebene Werte den Typ String aufweisen. Sie könnten auch ein fehlendes Attribut wie beispielsweise .users.*.active hinzufügen (hier können Sie es als BOOLEAN übergeben, da es entweder 'wahr' oder 'falsch' zurückgibt).

  Sie könnten auch die Option Normalize arrays (Arrays normalisieren) verwenden, um nur die OBJECT-Elemente in .users.*.addresses zu behalten, auch wenn Adressen auch einige String-Typen enthalten.

Diese Option ist verfügbar, wenn JSON in der Option Response body format (Format des Antwort-Bodys) in den Basiseinstellungen (Basic settings) der Komponente ausgewählt wird.