Rufen Sie eine externe API auf

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

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

Was Sie benötigen

• Ein UiPath Automation Cloud-Konto mit Zugriff auf Maestro Flow.
• Die Basis-URL der Ziel-API, der Endpunktpfad und die Authentifizierungsdetails (API-Schlüssel, Bearer-Token oder Basisauthentifizierungsanmeldeinformationen).

Verwendete Knoten

• Manual Trigger – startet den Workflow bei Bedarf
• HTTP-Anforderung – ruft die REST-API auf
• Datentransformation – Extrahiert die benötigten Felder aus der Antwort
• Skript – protokolliert Fehler auf dem Fehlerpfad der HTTP-Anforderung

Schritte

1. Erstellen Sie einen neuen Flow und fügen Sie einen Trigger hinzu

1. Öffnen Sie Maestro → Flow und erstellen Sie einen neuen Workflow.
2. Ziehen Sie einen Manual Trigger auf die Arbeitsfläche.

2. Fügen Sie den HTTP-Anforderungsknoten hinzu und konfigurieren Sie ihn

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

Für die API-Schlüsselauthentifizierung:

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

Für die Standardauthentifizierung:

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

3. Extrahieren Sie die benötigten Daten

1. Ziehen Sie einen Datentransformationsknoten auf die Arbeitsfläche und verbinden Sie ihn mit dem HTTP Request-Knoten.
2. Ordnen Sie im Konfigurationsbereich die von Ihnen benötigten Antwortfelder von $vars.httpRequest1.output.body den benannten 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 Folgendes zu:

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

4. Fügen Sie eine Fehlerbehandlung hinzu

1. Wählen Sie den Knoten „HTTP-Anforderung“ aus.
2. Ziehen Sie von dessen Fehler-Handle (der untere rechte Connector) auf einen neuen Skriptknoten .
3. Protokollieren Sie im Skriptknoten den Fehler von $vars.httpRequest1.error:

const error = $vars.httpRequest1.error;
console.log('API call failed:', error.message, '| Status:', error.status);
return null;

5. Testen und debuggen

Wählen Sie Test. In der Ausführungsablaufverfolgung:

• Überprüfen Sie die statusCode -Ausgabe des HTTP-Anforderungsknotens. 200 bedeutet Erfolg; 401 bedeutet, dass Ihre Authentifizierung falsch ist; 404 bedeutet, dass die URL falsch ist.
• Überprüfen Sie die Ausgabe des Datentransformationsknotens, um zu bestätigen, dass die Felder korrekt extrahiert wurden.
• Um den Fehlerpfad zu testen, legen Sie die URL vorübergehend auf einen ungültigen Wert fest und überprüfen Sie, ob der Fehlerpfad ausgeführt wird.

Ergebnis

Ihr Workflow ruft die REST-API auf, extrahiert die benötigten Felder aus der Antwort und protokolliert Fehler auf dem Fehlerpfad. Sie können den HTTP-Statuscode und die extrahierten Werte in der Ausführungsablaufverfolgung überprüfen und bestätigen, dass sowohl die Erfolgs- als auch die Fehlerpfade wie erwartet funktionieren.

Erweitern Sie diesen Workflow

• Handle für die Paginierung: Wenn die API Ergebnisse über mehrere Seiten hinweg zurückgibt, fügen Sie 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-Anforderungsknoten oder einen Integrationsknoten hinzu, um die Daten nach unten zu schieben.
• Zeitplan: Ersetzen Sie den manuellen Trigger durch einen geplanten Trigger , um den Workflow in einem regelmäßigen Intervall auszuführen.