# Anfragen

### Eine Anfrage stellen

#### Host

Der Host für Anfragen an Web API v1 ist immer `https://api.iafcertsearch.org/api/client/v1`

{% hint style="info" %}
Alle Anfragen müssen über HTTPS gestellt werden. Die API unterstützt kein HTTP.
{% endhint %}

#### Autorisierungs-Header

Sie müssen einen Autorisierungs-Header bereitstellen, wie in [Authentifizierung](https://github.com/QualityTrade/iaf-docs-api-developer-guide-de/blob/main/api-integration/broken-reference/README.md) beschrieben.

#### HTTP-Verben

* `GET` Ressource oder Gruppe von Ressourcen abrufen
* `POST` Neue Ressource erstellen
* `PUT` Vorhandene Ressource aktualisieren
* `DELETE` Vorhandene Ressource löschen
* `OPTIONS` Erlaubte Verben für eine spezifische Ressource anzeigen

#### Accept-Header

Die API liefert JSON-Antworten. Der accept-Header wird derzeit nicht benötigt, könnte dies jedoch in Zukunft sein. Wenn er nicht gesetzt ist, wird die API `application/json` verwenden.

```http
GET https://api.iafcertsearch.org/api/client/v1/endpoint HTTP/1.1
Accept: application/json
```

#### Datenarrays

Wenn Sie ein Datenarray in einer `GET`-Anfrage senden, müssen Sie den Parameter mehrmals in der URL angeben. Der Parametername benötigt keine Klammern.

```http
GET https://api.iafcertsearch.org/api/client/v1/endpoint?parameter=data1&parameter=data2 HTTP/1.1
```

### Formatierung Ihrer Anfrage

#### Anfragekörper

Wenn Sie Daten über `POST` oder `PUT` an eine Ressource senden, müssen Sie Ihre Nutzlast als JSON senden.

```http
POST https://api.iafcertsearch.org/api/client/v1/example/ HTTP/1.1
Content-Type: application/json
```

```json
{
  "name": "neuer Beispielname"
}
```

#### Seitenangabe

Einige `GET`-Ressourcen ermöglichen das Abrufen von Informationen in Stapeln. Wir geben die Abfragemöglichkeiten in der Ressourcendokumentation an, sofern zutreffend.

Wenn Sie mehrere Elemente anfordern, setzen wir die Anfragebeschränkung standardmäßig auf `20` Elemente. Sie können eine andere Beschränkung mithilfe des `limit`-Parameters angeben, wenn dies erforderlich ist. Der maximale Wert für den `limit`-Parameter, den wir akzeptieren, beträgt `100`.

Nachfolgend sehen Sie ein Beispiel für eine API-Anfrage, bei der die ersten 100 Datensätze gemäß den Parametern `limit=100` und `offset=0` abgerufen werden.

Um die nächste Stapel von Datensätzen abzurufen, erhöhen Sie den Wert des offset-Parameters um `1`.

```http
GET https://api.iafcertsearch.org/api/client/v1/resource?limit=100&offset=0 HTTP/1.1
```

### Erfolgreiche Anfragen

| **Verb** | **Zurückgegebenes Ressourcenobjekt**                                             |
| -------- | -------------------------------------------------------------------------------- |
| GET      | Gibt ein einzelnes Ressourcenobjekt oder ein Array von Ressourcenobjekten zurück |
| PATCH    | Gibt das aktualisierte Ressourcenobjekt zurück                                   |
| PUT      | Gibt das aktualisierte Ressourcenobjekt zurück                                   |
| DELETE   | Es wird kein Inhalt zurückgegeben                                                |
| POST     | Gibt das neu erstellte Ressourcenobjekt zurück                                   |


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://support.iafcertsearch.org/api-developer-guide/api-de/api-integration/requests.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.