Was ist ein API Request?
Ein API-Request ist ein Aufruf eines API (Application Programming Interface) und stellt eine Anfrage an diesen Endpunkt um Daten abzurufen oder zu ändern. Ein API fungiert als Vermittler zwischen einem Client und einem Server, so dass zwei separate Systeme miteinander kommunizieren können.
Wie funktioniert ein API-Request?
Bei einem Request an einen API-Endpunkt, also einer API-Anforderung sendet der Client eine Anfrage an die API, in der er die Art der Aktion angibt, die er durchführen möchte.
Solche Requests können z. B. das Abrufen von Daten oder das Durchführen einer bestimmten Operation sein. Die API verarbeitet dann die Anfrage und gibt eine Antwort an den Client zurück, in der Regel in Form einer Datenstruktur, wie JSON oder XML.
Die Struktur der Anfrage und der Antwort wird durch die API-Dokumentation bestimmt, in der die spezifischen Endpunkte und Parameter beschrieben sind, die zur Verwendung zur Verfügung stehen.
Einfaches Beispiel eines API-Requests
Ein Client könnte zum Beispiel eine API-Anfrage an eine Wetter-API stellen, um die aktuelle Temperatur für einen bestimmten Ort abzurufen. Die Anfrage würde die Standortinformationen und den API-Schlüssel enthalten, der für den Zugriff auf die API erforderlich ist.
Die API würde die Anfrage verarbeiten, die Temperaturdaten abrufen und sie in Form einer Antwort an den Kunden zurücksenden. Der Client könnte dann diese Daten verwenden, um die Temperaturinformationen in seiner eigenen Anwendung anzuzeigen.
Beispiel Code für einen API-Request an eine Wetterstation
Eine API-Anfrage zum Abrufen der aktuellen Wetterinformationen für Hamburg, Deutschland, unter Verwendung des Endpunkts https://www.meteonomiqs.com/weather-api/ in JavaScript könnte wie folgt aussehen:
fetch("https://www.meteonomiqs.com/weather-api/?location=Hamburg,Germany&APIKEY=<YOUR_API_KEY>")
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));
In diesem Beispiel wird die Fetch-Funktion verwendet, um eine GET-Anfrage an den API-Endpunkt zu senden.
Der Parameter location wird auf „Hamburg, Deutschland“ gesetzt, um Wetterinformationen für diesen Ort abzurufen.
Der Parameter APIKEY wird auf den Entwickler-eigenen API-Schlüssel gesetzt, den Du vom API-Anbieter erhälst.
Die API-Response – also die Antwort der API – liegt im JSON-Format vor, so dass die Methode response.json() zum Parsen der Antwort und Extrahieren der Daten verwendet wird. Die geparsten Daten werden dann zur Überprüfung auf der Konsole protokolliert.
Der catch-Block wird verwendet, um alle Fehler abzufangen, die während der Anfrage auftreten können.
Unterschied zwischen API-Request und API-Response
Ein API-Request und eine API-Response sind zwei getrennte Teile der Interaktion zwischen einem Client und einer API (Application Programming Interface).
Eine API-Anforderung ist eine Anfrage eines Clients an eine API zum Abrufen oder Ändern von Daten. Sie gibt die Art der Aktion an, die der Client durchführen möchte, z. B. das Abrufen von Informationen oder das Ausführen einer Operation. Die Anfrage wird in der Regel in Form einer Anforderungsnachricht gestellt, die Parameter und Kopfzeilen enthält, die der API zusätzliche Informationen liefern.
Eine API-Antwort hingegen sind die Daten, die von der API als Antwort auf eine API-Anfrage zurückgegeben werden. Sie enthält die vom Client angeforderten Informationen sowie etwaige Statuscodes, Fehlermeldungen oder andere für die Anfrage relevante Informationen. Die Antwort wird in der Regel in einem bestimmten Datenformat zurückgegeben, z. B. JSON oder XML, und ihre Struktur ist in der API-Dokumentation festgelegt.
Zusammenfassend lässt sich sagen, dass eine API-Anforderung die Anfrage des Clients nach Informationen oder Aktionen ist, während eine API-Antwort die von der API als Antwort auf diese Anforderung zurückgegebenen Informationen darstellt. Die beiden sind miteinander verbunden, da die API-Antwort die Informationen liefert, die der Client benötigt, um seine beabsichtigte Aktion auszuführen.
