> For the complete documentation index, see [llms.txt](https://docs.airops.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.airops.com/docs/de/aktionen/workflow-concepts/workflow-steps/logic-steps/api.md).

# API aufrufen

Externe APIs in deinem Workflow aufrufen

Der Hilfsschritt „API“ ermöglicht es Ihren AirOps-Workflows, über deren APIs mit externen Diensten zu kommunizieren. So können Sie Daten und Funktionen integrieren und mit ihnen interagieren, die außerhalb Ihres Workflows liegen.

## Konfiguration

Wählen Sie die von der externen API erforderliche Methode:

| Methode   | Häufige Verwendung                                                          |
| --------- | --------------------------------------------------------------------------- |
| **GET**   | Daten abrufen. Dies ist die Standardmethode und sendet keinen Request-Body. |
| **POST**  | Eine Ressource erstellen oder Daten übermitteln.                            |
| **PUT**   | Eine Ressource ersetzen oder aktualisieren.                                 |
| **PATCH** | Ausgewählte Felder einer Ressource aktualisieren.                           |

**POST**, **PUT**und **PATCH** akzeptiert ein **Inhalt** mit Liquid-Referenzen. Der Schritt unterstützt DELETE nicht. Konfigurierte Wiederholungsversuche gelten für alle vier unterstützten Methoden.

### Eingaben oder Ausgaben im API-Schritt referenzieren

Um Variablen in Ihrer API dynamisch festzulegen und auf eine Eingabe (im „Start“-Schritt definiert) oder eine Ausgabevariable (von einem beliebigen Schritt generiert) zu verweisen, müssen Sie die Liquid-Syntax verwenden. Außerdem müssen Sie Ihre Header- und Body-Werte angeben.

#### Header

Damit Sie Ihren Header-Wert übergeben können, ist es wichtig, dass Sie die Informationen als JSON formatieren. Wir setzen unseren Content-Type immer wie unten gezeigt, und Sie können den API-Schlüssel für alle Aufrufe angeben, die eine Autorisierung erfordern:

```javascript
{ 
    "authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}
```

#### Inhalt

Der Body ermöglicht es uns, zusätzliche Parameter (d. h. Variablen oder Ausgaben) anzugeben, die in den API-Aufruf aufgenommen werden sollen. Wir verwenden dieselbe Syntax wie beim Header, wobei sowohl unsere Schlüssel als auch Werte in Anführungszeichen gesetzt werden. Wenn wir Eingaben oder Schrittausgaben übergeben, verwenden wir die Liquid-Syntax und setzen sie dennoch in doppelte Anführungszeichen, z. B.

```javascript
{
  "properties": {
    "amount": "",
    "dealname": "{{ step_2.output.deal_name }}",
    "pipeline": "",
    "closedate": "{{ step_2.output.deal_close_date }}",
    "dealstage": "",
    "hubspot_owner_id": ""
  }
}
```

#### Beispiele

Setzen wir das alles anhand einiger Beispiele zusammen. Wenn Sie zu Beginn Ihres Workflows eine Benutzereingabe mit dem Namen location definiert haben, können Sie {{ location }} in der URL oder im Body Ihres API-Schritts einfügen, um eine Anfrage an eine Wetter-API zu senden:

```
GET https://api.weatherapi.com/v1/current.json?key=YOUR_API_KEY&query={{ location }}
```

Ebenso können Sie Ausgaben anderer Schritte als Variablen verwenden. Wenn Sie einen Schritt haben, der die ID eines Benutzers abruft, können Sie die Ausgabe dieses Schritts als Variable im API-Schritt verwenden:

```
POST https://api.example.com/user/{{ step_1.output }}/profile
```

Dadurch können Sie dynamische API-Anfragen erstellen, die sich anhand der Eingaben und Ausgaben in Ihrem Workflow anpassen. Als Beispiel können Sie auf den unten gezeigten API-Schritt in unserer Vorlage „Sales Call Lead Qualifier“ verweisen:

<figure><img src="https://1960680173-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-b1d6cf573dc35bc5b122fd0dc6a947a6beefc0f9%2Futility_api_1.png?alt=media" alt=""><figcaption><p>Unser API-Schritt ruft die Fireflies-API auf</p></figcaption></figure>

## So fahren Sie fort, wenn der API-Schritt fehlschlägt

Standardmäßig beendet der API-Schritt den Workflow, wenn er fehlschlägt. Um den Workflow jedoch fortzusetzen, wenn der Schritt fehlschlägt, klicken Sie einfach auf `Weiter` am unteren Rand des Schritts.

<figure><img src="https://1960680173-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-909683bdffa53e503c67fcbd3d10be9b91f137e8%2Fimage.png?alt=media" alt=""><figcaption><p>Klicken Sie auf Fortfahren, um den Workflow fortzusetzen</p></figcaption></figure>

Der Schritt gibt die folgenden Schlüssel zurück:

* `Ausgabe` : dies wird `null`
* `Fehler` :
  * `Meldung`: die vom Schritt zurückgegebene Meldung
  * `Code` : der den Fehler darstellende Fehlercode

<figure><img src="https://1960680173-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-efafda7fe1d5464d514822509633ec2c8de54f23%2Fimage.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

## So wiederholen Sie den API-Schritt bei einem Fehler

Sie können den API-Schritt bis zu 3 Mal erneut ausführen, indem Sie auf **Erweiterte Einstellungen**

Wenn der Schritt jedoch nach 3 Wiederholungsversuchen immer noch fehlgeschlagen ist, können Sie:

1. Wählen Sie `Weiter` anstatt `Workflow beenden` wenn der Schritt fehlschlägt
2. Fügen Sie eine Bedingung hinzu, bei der die Bedingung prüft, ob der `Fehler` aus dem Schritt vorhanden ist, z. B. `step_1.error`
3. Fügen Sie den Schritt hinzu, den Sie erneut versuchen möchten, falls ein Fehler aufgetreten ist

<figure><img src="https://1960680173-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-f551698d248295d68e604a0eaf0092b8d6134100%2Fimage.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

## Benötigen Sie mehr Kontrolle?

Für erweiterte API-Anfragen verwenden Sie unseren Python-Schritt mit benutzerdefiniertem Code und verwenden Sie den [Code-Schritt](https://docs.airops.com/docs/code-step), der externe Anfragen stellen kann.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.airops.com/docs/de/aktionen/workflow-concepts/workflow-steps/logic-steps/api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.