Module
Was sind Module?
Module können Aktionen bzw. Anfragen im Flow ausführen. Diese Module sind als Schritte im Bot Builder vorhanden und können dort verwendet werden.
HTTP-Abfrage und Verbindung auswählen erstellen
Diese Abfrage wird beim Ausführen des Moduls/der Funktion an den gewünschten Endpunkt geschickt. Zusätzlich muss wie bereits in Verbindungenerwähnt wurde eine Verbindung für diese App-Modul ausgewählt werden.
Erklärung Bestandteile HTTP-Abfrage
url
: Erweiterung der Basis-URL um den gewünschten Endpunktheaders
:Content-Type
: Festlegung auf JSON-Format des Anforderungs-Headers und der Antwortmeist wird hier noch für die Autorisierung "
authorization"
ein Token oder API-Key mit dem Platzhalter{{parameters.apiKey}}
method
: Methode des Aufrufes (GET)qs
: Sammlung von Parametern in Form eines Query-Strings (qs
)
Vollständige URL der HTTP-Abfrage
Die zusammengesetzte vollständige URL diese HTTP-Aufrufes würde wie folgt lauten:
Beispiel HTTP-Abfrage
Dummy POST-HTTP-Abfrage
Hierbei handelt es sich um ein Dummy POST-HTTP-Abfrage, die nicht in der "Chuck Norrs Jokes Api" erreichbar ist und nur für Veranschaulichungszwecke benutzt wird.
Es wird ein Witz mit der Kategorie ("category
") und dem Witzetext ("value
") aus dem Body erstellt. Es müssen dementsprechend im Teil Festlegen der Parameter diese Parameter angelegt werden.
Festlegen der Parameter
Die Parameter stellen notwendigen Informationen für die HTTP-Abfrage des Moduls dar. Diese Parameter müssen im Bot Builder beim Ausführen eines Moduls mitgeben werden.
Erklärung Bestandteile Parameter
name
: Eindeutiger Namen des Parameterstype
: Datentyp (text
,number
oderboolean
)label
: Label, das im Bot Builder im entsprechenden App-Modul aufgeführt istdas Feld im App-Modul für die Eingabe der Daten trägt diesen Namen
required
: Gibt an, ob der Parameter erforderlich ist (true
oderfalse
)
Beispiel Parameter
Definition des Outputs
Hier werden Informationen zum Aufbau der erwarten Antwort des Endpunktes festgelegt. Der Aufbau der Antwort muss exakt definiert werden, da sonst Werte nicht weiter verarbeitet werden können. Die aufgelisteten Objekte sind Variablen der Konversation, die nach erfolgreichem Ausführen des App-Moduls entsprechend gesetzt werden. Mit diesen Variablen kann nun im Flow weitergearbeitet werden.
Erklärung Bestandteile Output
name
: Eindeutiger Name des Ouput-Wertesdiese Name muss exakt dem Namen in der HTTP-Antwort entsprechen
type
: Datentyp (text
,number
oderboolean
)label
: Name der Variablenunter diesem Namen ist die Variablen nach ausführen des App-Moduls verfügbar
Beispiel Output
Last updated