Externe API-Anforderungen
Kommunizieren Sie mit jeder API und integrieren Sie jeden Dienst.
Mit externen API-Anforderungen können Sie Anforderungsvorlagen definieren und dann ausgehende Aufrufe an eine beliebige API aus Geschäftsprozessen heraus auslösen. Mit ihnen können Sie Ihr Projekt mit jedem beliebigen Dienst eines Drittanbieters verbinden, selbst wenn es dafür noch kein Modul auf dem Markt gibt.
Definition
Lesen Sie in der API-Dokumentation des Dienstanbieters, mit dem Sie eine Verbindung herstellen möchten, nach, wie die Anfrage strukturiert sein sollte.
- Um eine neue Anforderungsvorlage zu definieren, gehen Sie auf die Registerkarte "Business Logic" in der Seitenleiste (1), wechseln Sie zur Registerkarte "External API Requests" (2) und klicken Sie auf "New API Request" (3).
3. Wählen Sie die HTTP-Methode der Anfrage und ihre URL.
4. Definieren Sie URL-Parameter, Query-Parameter (nur für GET-Anfragen), Header und den Body der Anfrage, indem Sie den Parameternamen (1) und seinen Typ (2) eingeben und auf "Add Param" (3) klicken.
Der tatsächliche Wert dieser Parameter wird zum Zeitpunkt der Ausführung des Geschäftsprozesses, bei dem die Anfrage ausgelöst wird, festgelegt.
Um den Unterschied zwischen URL- und Abfrageparametern zu verstehen, lesen Sie bitte hier weiter. Unabhängig von den Standards ist die API-Dokumentation des Dienstanbieters, mit dem Sie eine Verbindung herstellen möchten, die beste Informationsquelle für die Erstellung der Anfrage.
Sie können die Header und den Body der Anfrage auch automatisch ausfüllen, indem Sie ein JSON-Beispiel eingeben; das System erstellt dann automatisch alle erforderlichen Parameter.
Sie müssen nicht bei jeder Registerkarte neue Parameter hinzufügen. Manche Anfragen enthalten z. B. überhaupt keine URL-Parameter, Kopfzeilen oder Textkörper.
Falls Ihre Anfrage Objekte enthält (z.B. Auto -> Farbe, Größe, etc.), müssen Sie virtuelle Modelle erstellen, um diese Objekte später in Ihren Geschäftsprozessen zu verarbeiten. Wählen Sie dazu im Parametertyp-Selektor "Modell" aus und fügen Sie die benötigten untergeordneten Elemente ein. Sie können die Objekte so oft wie nötig verschachteln (d. h. Objekt in Objekt) und virtuelle Modell-Arrays erstellen. Falls Sie das automatische Ausfüllen verwendet haben, wurde dieser Vorgang automatisch abgeschlossen.
5. Ändern Sie die Einstellungen der Anfrage, wie z. B. SSL-Verifizierung, Timeout und Fehlerbehandlung auf der Registerkarte "Einstellungen".
7. Speichern Sie die Anfragevorlage, indem Sie auf "Anfrage speichern" klicken.
verwenden
Nachdem Sie einen neuen Antrag definiert und gespeichert haben, wird ein neuer Block im Geschäftsprozess-Editor verfügbar, um ihn auszulösen.
Sie müssen ihm alle Komponenten, die Sie der Anfrage hinzufügen möchten (URL- und Abfrageparameter, Kopfzeilen und Body) als Datenmodelle zur Verfügung stellen, die mithilfe dieser Blöcke erstellt werden können. In der Ausgabe können Sie den formatierten Body der Antwort, ihre Kopfzeilen und den Antwortstatus extrahieren. Sie können diese Modelle mit Hilfe dieser Blöcke erweitern.
Sie müssen nicht alle Dateneingänge verbinden, damit die Anfrage korrekt ausgelöst wird. Wenn Sie z. B. eine Anfrage ohne URL-Parameter haben, müssen Sie das Modell nicht erstellen und es nicht verbinden.
Für jedes virtuelle Modell, das Sie definiert haben, werden 2 neue Blöcke zu Ihrem Geschäftsprozess-Editor hinzugefügt, um es zu erstellen und zu erweitern.
Überwachung
Jedes Mal, wenn Sie eine API-Anforderung auslösen, gibt das System den Typ und die Adresse der Anforderung, den Request Body, den HTTP-Statuscode der Antwort und den Response Body in den Protokollen aus. Sie können weitere Informationen, wie z. B. bestimmte Felder des Antwortkörpers oder die Latenzzeit, in Protokolle ausgeben, indem Sie den Block Write to Log verwenden.
