Webanfrage – BETA
1 min
Mithilfe der Phase "Webanfrage" rufen Sie Informationen für die Verwendung innerhalb des Bots oder zur Vornahme von Änderungen in einem externen System ab. Die Phase wird über die Ivanti Neurons-Plattform einmal für jedes Gerät ausgeführt, das die Phase durchläuft. Sie kann mit externen REST-APIs interagieren und wird für nicht authentifizierte und authentifizierte APIs unterstützt.
Anleitung zum Konfigurieren der Phase "Webanfrage"
- Fügen Sie einem Bot auf der Seite "Bot erstellen" die Phase Webanfrage hinzu und öffnen Sie die Phaseneinstellungen.
- Wählen Sie im Dropdownmenü Anmeldeinformationen auswählen die Anmeldeinformationen aus, falls für die Webanfrage eine Authentifizierung erforderlich ist. Wenn Sie neue Anmeldeinformationen benötigen, klicken Sie auf Anmeldeinformationen hinzufügen, um den Speicher für Anmeldeinformationen aufzurufen. Derzeit werden die Authentifizierung über Basic API und API-Schlüssel unterstützt. Falls keine Anmeldeinformationen erforderlich sind, übernehmen Sie die Standardeinstellung Keine Authentifizierung.
- Wenn Sie die automatisch generierten Kopfzeilen anzeigen möchten, schalten Sie bei Kopfzeilen den Umschalter Automatisch generierte Kopfzeilen auf Ein. Die Kopfzeilen entsprechen den Anforderungen der Ziel-API. Weitere Informationen sind der Dokumentation des Drittanbieters zu entnehmen.
- Schlüssel: Geben Sie den Kopfzeilenschlüssel für die Webanfrage ein.
- Wert: Geben Sie den Kopfzeilenwert für die Webanfrage ein.
- Wählen Sie die Methode aus. Dies ist die HTTP-Methode, die zum Aufrufen der Ziel-API verwendet wird. Folgende Methoden werden unterstützt: GET, POST, PUT, PATCH und DELETE.
- Geben Sie die API-Adresse ein. Die Adresse muss über das Internet zugänglich sein. Wenn Sie Werte aus einer anderen Phase oder Bot-Eingabe übergeben möchten und wenn die Ziel-API JSON-Payloads unterstützt, klicken Sie auf JSON-Textkörper bearbeiten, um den JSON-Editor aufzurufen. Wählen Sie die einzuschließenden Werte aus (die Webanfrage-Phase muss mit den vorgelagerten Phasen verbunden sein, damit Informationen weitergegeben werden).
- Wählen Sie den für die API-Antwort geeigneten Ausgabemodus. Falls Sie die HTTP-Methode GET ausgewählt haben, ist dies in der Regel JSON.
- Klicken Sie auf Testen und Antwort abrufen, um die API sofort aufzurufen. Falls im JSON-Textkörper Variablen aus früheren Phasen enthalten waren, werden Sie aufgefordert, Beispieldaten einzugeben.
- Die Beispielantwort wird anhand der Aktion "Testen und Antwort abrufen" befüllt. Nachdem Sie die Antwort verifiziert haben, können Sie bestimmen, ob es sich um Einzelergebnisse (eindeutige Felder pro Endpunkt) oder um Arrays (mehrere Werte für ein bestimmtes Feld pro Endpunkt) handelt.
- Falls es sich bei den Ergebnissen um einen Array handelt, aktivieren Sie den Zuordnungsarray. Befindet sich die Phase im Modus "Zuordnungsarray" wird für jede Phase die Kennzeichnung "Mehrere" angezeigt, d. h. zum Verwenden der Ergebnisse in den meisten anderen Phasen müssen Sie einen "Für jede/n/s"-Block verwenden, um den Inhalt für jedes Ergebnis auszuführen.
- Geben Sie den Pfad zum Array ein.
- Sobald der Umschalter Zuordnungsarray auf Ein steht, füllen Sie die folgenden Attribute für die Feldzuordnung aus:
- Pfad innerhalb des Arrayelements: Der Pfad zum Objekt in der JSON-Antwort. Dies kann nur der Name sein. Wenn das Objekt allerdings verschachtelt ist, muss der Pfad unter Verwendung der Punktsyntax angegeben werden, z. B. ebene1.ebene2.meinfeld Beispiel für Einzelergebnis: {"configuration": {startup_events": {"updates": "some value"}}} Pfad zu Updates: configuration.startup_events.updates Beispiel für Array: {"users": [{display_info": {"name": "John"}}]} Pfad zum Array: users Pfad innerhalb des Arrays: display_info.name
- Typ: Dieser muss dem Format des gelesenen Werts entsprechen, sodass die richtigen Filter/das richtige Verhalten auf zukünftige Phasen angewendet werden kann.
- Zugeordnete Beschriftung: Dies ist der Anzeigename, der in der Token-Auswahl und in den Filtern nachfolgender Phasen angezeigt wird.
Nachdem Sie die Attribute des Zuordnungsarrays ausgewählt haben, klicken Sie auf Zuordnung testen, um die Zuordnungen in der Beispielantwort zu testen und sicherzustellen, dass sie korrekt sind.
