Rufen Sie eine externe API auf

Rufen Sie eine authentifizierte Representational State Transfer (REST)-API auf, behandeln Sie die Antwort und extrahieren Sie Daten für nachgelagerte Workflow-Knoten.

Was Sie erstellen: Einen Workflow, der eine authentifizierte Representational State Transfer (REST)-API aufruft, die Antwort behandelt und die extrahierten Daten für nachgelagerte Knoten verfügbar macht. Dies ist eines der häufigsten Muster in Flow – es gilt für jedes System, das einen HTTP-Endpunkt bereitstellt.

Was Sie benötigen

• A UiPath Automation Cloud account with access to Flow.
• Die Basis-URL, der Endpunktpfad und die Authentifizierungsdetails (API-Schlüssel, Bearer-Token oder grundlegende Authentifizierungsinformationen) der Ziel-API.

Verwendete Knoten

• Manueller Trigger – startet den Workflow bei Bedarf
• HTTP-Anforderung – ruft die REST-API auf
• Transform — extracts the fields you need from the response
• Script — returns the error details on the HTTP Request's error path

Schritte

1. Einen neuen Flow erstellen und einen Trigger hinzufügen

1. Open Maestro Orchestrate → Flow and create a new workflow.
2. Ziehen Sie einen manuellen Trigger auf die Arbeitsfläche.

2. HTTP-Anforderungs-Knoten hinzufügen und konfigurieren.

1. Ziehen Sie einen HTTP-Anforderungs-Knoten auf die Arbeitsfläche und verbinden Sie ihn mit dem Trigger.
2. Im Konfigurationsbereich:
   • Legen Sie die Methode auf das entsprechende Verb fest (GET, POST, PUT, PATCH, oder DELETE).
   • Geben Sie die vollständige URL des Endpunkts ein.
   • Fügen Sie unter Header Authentifizierungs- und Content-Type-Header hinzu.

Für die API-Schlüsselauthentifizierung:

Fügen Sie einen Header mit Schlüssel Authorization und Wert Bearer {{ secret.apiKey }} hinzu. Das secret. Präfix weist Flow an, den Wert aus Ihrem sicheren Variablenspeicher nachzuschlagen – fügen Sie den Schlüssel niemals direkt in das Feld ein.

Für die grundlegende Authentifizierung:

Fügen Sie einen Header mit Schlüssel Authorization und Wert Basic {{ secret.encodedCredentials }} hinzu, wobei encodedCredentials der base64-codierte username:password String ist.

3. Die erforderlichen Daten extrahieren

1. Ziehen Sie einen Data-Transform-Knoten auf die Arbeitsfläche und verbinden Sie ihn mit dem HTTP-Anforderungs-Knoten.
2. Ordnen Sie im Konfigurationsbereich die Antwortfelder, die Sie benötigen, $vars.httpRequest1.output.bodybenannten Ausgabevariablen zu.

Um beispielsweise den Namen und die E-Mail-Adresse eines Benutzers aus einer Antwort wie { "user": { "name": "Alex", "email": "[e-mail]" } }, zu extrahieren, ordnen Sie folgendermaßen zu:

• $vars.httpRequest1.output.body.user.name → userName
• $vars.httpRequest1.output.body.user.email → userEmail

4. Error-Behandlung hinzufügen

1. Wählen Sie den HTTP-Anforderungsknoten aus, öffnen Sie die Registerkarte Fehlerbehandlung und aktivieren Sie Fehlerbehandlung aktivieren. Ein Fehler- Handle wird unter dem Hauptausgabe-Handle angezeigt.
2. Wählen Sie + für das Fehler- Handle aus, suchen Sie nach Skript und wählen Sie es aus.
3. In the Script node, return the error details from $vars.httpRequest1.error. The returned message appears in the execution trace:

const error = $vars.httpRequest1.error;
return {
  message: "Error raised: " + error.message,
  status: error.status
};

5. Testen und Debuggen

Wählen Sie Test aus. Im Ausführungs-Trace:

• Aktivieren Sie die statusCode Ausgabe des HTTP-Anforderungs-Knotens.200 bedeutet Success; 401 bedeutet, dass Ihre Authentifizierung falsch ist; 404 bedeutet, dass die URL falsch ist.
• Prüfen Sie die Ausgabe des Datentransformationsknotens, um sicherzustellen, dass die Felder korrekt extrahiert wurden.
• Um den Error-Pfad zu testen, legen Sie die URL vorübergehend auf einen ungültigen Wert fest und überprüfen Sie, ob der Error-Pfad ausgeführt wird.

Ergebnis

Your workflow calls the REST API, extracts the fields you need from the response, and returns the error details on the error path. You can inspect the HTTP status code and extracted values in the execution trace, and confirm both the success and error paths work as expected.

Diesen Workflow erweitern

• Paginierung behandeln: Wenn die API Ergebnisse auf mehreren Seiten zurückgibt, fügen Sie Folge-HTTP-Anforderungsknoten hinzu, um zusätzliche Seiten abzurufen, und verzweigen Sie mit einer Entscheidung, ob die Antwort einen Cursor für die nächste Seite enthält.
• Ergebnisse in ein anderes System schreiben: Fügen Sie nach dem Datentransformationsknoten einen weiteren HTTP-Anforderungs-Knoten oder einen Integrationsknoten hinzu, um die Daten nachgelagert zu verschieben.
• Planen: Ersetzen Sie den manuellen Trigger durch einen Geplanten Trigger, um den Workflow in einem regelmäßigen Intervall auszuführen.