Rufen Sie eine externe API auf

Build a workflow step by step that calls an API with HTTP Request, then reshapes the response with Transform and Script.

Was Sie erstellen

Ein Workflow, der eine authentifizierte REST-API (Representational State Transfer) aufruft, verarbeitet die Antwort und stellt die extrahierten Daten den Knoten danach zur Verfügung. Eine REST-API ist ein Webdienst, den andere Software über HTTP aufrufen kann. Das Muster gilt für jedes System, das eine HTTP-API verfügbar macht.

Bevor Sie beginnen

• 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.
• Transformation: Extrahiert die benötigten Felder aus der Antwort.
• Skript: Protokolliert Fehler auf dem Fehlerpfad der HTTP-Anforderung.

Schritte

Tipp:

Wenn ein Codierungsagent eingerichtet ist, können Sie die manuellen Schritte überspringen. Fragen Sie:

Build a Maestro Automate workflow that starts manually with a userId, calls GET https://dummyjson.com/users/{userId} with an HTTP Request node, returns the user's name and email, and logs the error on the node's error path if the call fails.

Öffnen Sie dann den Workflow auf der Arbeitsfläche, vergleichen Sie ihn mit den folgenden Schritten und testen Sie ihn. Einrichten Ihres Codierungs-Agents beschreibt das Setup.

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

Erstellen Sie ein Projekt, wie Ihr erster Workflow beschreibt. Die Arbeitsfläche wird bereits mit einem Manual Trigger geöffnet.

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

1. Wählen Sie + am Ausgabehandle des Manual Trigger aus, suchen Sie nach HTTP Request und wählen Sie diese aus.
2. Im Eigenschaftenbereich:
   • 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 Authentifizierung mit Bearer-Token:

Fügen Sie einen Header mit dem Schlüssel Authorization und dem Wert Bearer {{ secret.apiKey }} hinzu. Das Präfix secret. liest den Wert aus dem sicheren Variablenspeicher. Der Schlüssel wird nie direkt in das Feld eingefügt.

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. Die erforderlichen Daten extrahieren

1. Wählen Sie + am Ausgabehandle des HTTP-Anforderungsknotens aus, suchen Sie nach Datentransformation und wählen Sie es aus.
2. Ordnen Sie im Eigenschaftenbereich 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 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. Protokollieren Sie im Skript-Knoten den Error aus $vars.httpRequest1.error:

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

5. Testen und Debuggen

Select Run Debug (▶) in the bottom toolbar of the canvas. In the execution trace:

• Aktivieren Sie die code 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

Der Workflow ruft die REST-API auf, extrahiert die Felder aus der Antwort und protokolliert Fehler auf dem Fehlerpfad. Das Execution Trace zeigt den HTTP-Statuscode und die extrahierten Werte für beide Pfade.

Diesen Workflow erweitern

• Behandeln Sie 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-Anforderungs-Knoten oder einen Integrationsknoten hinzu, um die Daten nachgelagert zu verschieben.
• Zeitplan: Ersetzen Sie den manuellen Trigger durch einen geplanten Trigger , um den Workflow in einem regelmäßigen Intervall auszuführen.

Nächste Schritte

• Bereitstellung eines Workflows: Lassen Sie den Workflow ohne Sie ausführen.
• Anleitungen: Weitere Workflows zum Erstellen.
• Community: Teilen Sie, was Sie erstellt haben, oder bitten Sie andere Builder um Hilfe.