Zum Hauptinhalt springen

HTTP

Die HTTP Anbindung in linqi erlaubt es generische Webservices anzubinden. Sie ist daher eine der flexibelsten Möglichkeit um Drittsysteme anzubinden, benötigt jedoch auch das meiste technische Wissen.

info

Um die HTTP Anbindung nutzen zu können müssen Sie das entsprechende Feature in der Mandanten Administration aktivieren.

Verbindung​

Um über die HTTP Aktionen in linqi mit Drittsysteme kommunizieren zu können müssen Sie zuerst eine entsprechende Verbindung in der Verbindungsverwaltung ( Button in der Navigation) anlegen.
Auf der Verbindungsliste können Sie dafür das Plus an der oberen rechten Seite nutzen und anschließend HTTP-Verbindung auswählen.

In den Verbindungseinstellungen haben Sie folgende Möglichkeiten:

  • Anzeigename:
    Der Anzeigename hilft Ihnen die Verbindung wiederzuverwenden und kann frei vergeben werden.
  • Art der Verbindung:
    Hier können Sie bestimmen welche Art der Authentifizierung genutzt wird. Hier gibt es folgende Auswahlmöglichkeiten:
    • Anonymous:
      Es wird keine Authentifizierung durchgeführt. Dies kann aber z.B. nützlich sein, wenn über einen HTTP Header ein API Key mitgeschickt wird.
    • Basic:
      Es wird Basic Authentication mit Benutzername und Passwort durchgeführt.
    • Windows:
      Es wird NTLM bzw. Kerberos, wenn verfügbar, mit Windows Benutzernamen und Passwort genutzt.
  • Benutzername:
    Wenn Sie eine Verbindungsart, die einen Benutzername benötigt verwenden, müssen Sie hier den Benutzernamen (im Falle von Windows inklusive Domain)
  • Passwort:
    Wenn Sie eine Verbindungsart, die ein Passwort benötigt verwenden, müssen Sie hier das Passwort eingeben. Dieses kann anschließend nicht wieder abgefragt werden.
  • Berechtigte Personen:
    Hier können Sie einschränken welche Personen diese Verbindung im Prozessdesigner verwenden können, Details finden Sie hier.

Aktionen​

HTTP Anfrage​

Über diese Aktion können Sie HTTP Anfragen an Webservices senden, um Daten zu senden oder auch zu laden. Dabei stehen folgende Konfigurationsmöglichkeiten zur Verfügung:

  • Verbindung:
    Wählen Sie hier die Verbindung (s.o.) aus, welche genutzt wird, um sich am Webservice anzumelden.
  • Url:
    Hier können Sie die Url angeben welche angefragt wird.
  • Methode:
    Wählen Sie die HTTP-Anfragemethode aus welche genutzt wird. Falls Sie eine andere Methode als GET verwenden können Sie folgende Formate definieren:
    • Text:
      Verwenden Sie dieses Format um z.B. JSON oder XML an einen Webservice zu senden.
    • Datei:
      Über dieses Format können Sie Dateien an den Webservice senden.
    • Multipart:
      Wenn Sie dieses Format auswählen können Sie sowohl Text als auch Dateien als einen Request an einen Webservice senden. So können Sie z.B. eine Datei mit Metadaten senden.
  • Header:
    Hier können Sie Header einfügen um z.B. einen API-Key, Content-Type etc. zu übermitteln
  • Format der empfangenden Daten:
    Wenn Sie Daten von einem Webservice laden wollen und diese über einen Platzhalter referenzieren wollen, können Sie hier definieren, ob Sie eine Antwort in JSON oder Datei Format erwarten. Dabei können Sie folgende Konfigurationen treffen:
    • JSON Schema:
      Wenn Sie eine JSON Antwort erwarten können Sie hier ein JSON Schema angeben. Die Antwort wird gegen dieses JSON Schema validiert und die definierten Eigenschaften können, nachdem Sie den Prozess gespeichert haben, als Platzhalter referenziert werden.
    • Dateiname:
      Definieren Sie den Dateinamen der für die heruntergeladene Datei verwendet werden soll.
  • Fehlerausgang aktivieren:
    Sobald Sie diesen Schalter aktivieren, können Sie Fehler abfangen und verarbeiten.

HTTP Webhook​

Diese Aktion kann als Prozessstart genutzt werden um z.B. automatisiert einen Prozess zu starten, wenn in einem Drittsystem etwas passiert. Dabei stehen folgende Konfigurationsmöglichkeiten zur Verfügung:

  • Webhook URL:
    Hier wird die URL angezeigt, an welche Sie eine Anfrage senden müssen, um den Webhook auszulösen.
  • Benutzer Kontext:
    Geben Sie hier die Person an für welche ein Prozess gestartet wird. Sie können die Berechtigungen anschließend natürlich direkt über die entsprechenden Aktionen anpassen.
  • Format der empfangenden Daten:
    Wenn Sie erwarten, dass der Webhook Daten an linqi sendet und Sie die Daten über einen Platzhalter referenzieren wollen, können Sie hier definieren in welchem Format die Daten erwartet werden. Dabei können Sie folgende Konfigurationen treffen:
    • JSON Schema:
      Wenn Sie eine JSON Anfrage erwarten können Sie hier ein JSON Schema angeben. Die Anfrage wird gegen dieses JSON Schema validiert und die definierten Eigenschaften können, nachdem Sie den Prozess gespeichert haben, als Platzhalter referenziert werden.
    • Dateiname:
      Definieren Sie den Dateinamen der für die empfangene Datei verwendet werden soll. Wenn Sie keinen Dateinamen angeben, wird der Dateiname der empfangenen Datei verwendet.