Was ist eine API-Anfrage?

Wie API-Anfragen funktionieren

Bei einer API-Anfrage sendet die Client-Anwendung eine Anfrage an einen bestimmten API-Endpunkt, der durch eine eindeutige URL identifiziert wird. Die Anfrage enthält eine HTTP-Methode (wie GET, POST, PUT oder DELETE), die die Aktion angibt, die an der Ressource ausgeführt werden soll.

Nach Erhalt der Anfrage verarbeitet der API-Server diese, führt die Aktionen aus oder ruft die angeforderten Daten ab und sendet eine Antwort an die Client-Anwendung zurück. Die Antwort enthält normalerweise einen Statuscode, der den Erfolg oder Misserfolg der Anfrage anzeigt, zusammen mit den angeforderten Daten oder relevanten Nachrichten.

Komponenten eines API-Aufrufs

Für einen erfolgreichen API-Aufruf sind mehrere Komponenten erforderlich:

1. URI oder URL: Die eindeutige Adresse des externen Servers oder Programms, von dem die Daten oder der Dienst angefordert werden.
2. HTTP-Verb: Die HTTP-Methode (GET, POST, PUT, DELETE), die angibt, welche Aktion an der Ressource ausgeführt werden soll, z. B. das Abrufen von Daten, das Erstellen einer neuen Ressource, das Aktualisieren einer bestehenden oder das Löschen einer Ressource.
3. Header: Zusätzliche Informationen, die der API Details über die Anfrage und das erwartete Antwortformat mitteilen, wie z. B. den Content-Type (z. B. JSON oder XML) und Authentifizierungs-Token.
4. API-Schlüssel oder Access-Token: Eine eindeutige Kennung für Authentifizierungs- und Tracking-Zwecke, die sicherstellt, dass nur autorisierte Clients auf die API zugreifen können und bei der Überwachung der Nutzung für Abrechnungs- oder Rate-Limiting-Zwecke hilft.
5. Parameter und Request-Body: Daten, die zusammen mit der Anfrage gesendet werden, um der API Informationen zu liefern, wie z. B. Query-Parameter in der URL oder Daten im Request-Body für POST- und PUT-Anfragen.

Durch die Einbeziehung dieser Komponenten in eine API-Anfrage kann eine Client-Anwendung mit einem API-Endpunkt kommunizieren, die gewünschten Daten abrufen oder die angeforderten Aktionen ausführen und eine Antwort erhalten, die verwendet werden kann, um den Status der Anwendung zu aktualisieren oder Informationen für den Benutzer anzuzeigen.

REST-APIs

REST (Representational State Transfer) ist ein Architekturstil für die Gestaltung von Netzwerkanwendungen. REST-APIs verwenden Standard-HTTP-Methoden (GET, POST, PUT, DELETE), um Operationen an Ressourcen durchzuführen. Diese Ressourcen werden normalerweise im JSON- oder XML-Format dargestellt und können über eindeutige URLs aufgerufen werden.

REST-APIs sind einfach, skalierbar und flexibel. Sie sind zustandslos, was bedeutet, dass jede Anfrage alle notwendigen Informationen enthält, damit der Server sie verarbeiten kann, ohne sich auf vorherige Anfragen zu verlassen. Dies macht REST-APIs leicht cachebar und trägt zur Verbesserung der Performance bei.

SOAP-APIs

SOAP (Simple Object Access Protocol) ist ein Protokoll für den Austausch strukturierter Informationen in Webservices. Im Gegensatz zu REST verwenden SOAP-APIs XML für das Messaging und folgen strengeren Regeln. SOAP-Nachrichten werden über verschiedene Protokolle wie HTTP, SMTP oder TCP gesendet und bestehen normalerweise aus einem Envelope, Header und Body.

SOAP-APIs können komplexer sein als REST-APIs aufgrund ihrer umfangreichen Konfigurationsoptionen und der Verwendung von XML. Sie bieten jedoch integrierte Fehlerbehandlung, Unterstützung für mehrere Transportprotokolle und starke Typisierung, was in bestimmten Szenarien nützlich sein kann.

GraphQL-APIs

GraphQL ist eine Abfragesprache für APIs und eine Runtime für die Erfüllung dieser Abfragen mit vorhandenen Daten. GraphQL wurde von Facebook entwickelt und ermöglicht es Clients, bestimmte Datenfelder anzufordern, wodurch die Anzahl der benötigten Anfragen reduziert und die Menge der übertragenen Daten minimiert wird.

Mit GraphQL senden Clients Abfragen an einen einzigen Endpunkt und geben die gewünschten Datenfelder an. Der Server antwortet dann mit genau den angeforderten Daten in einem strukturierten Format. Dieser Ansatz macht mehrere Endpunkte überflüssig und behebt das Overfetching oder Underfetching von Daten, häufige Probleme bei REST-APIs.

Webhooks

Webhooks sind eine Art von API, die Echtzeit-Benachrichtigungen an eine angegebene URL sendet, wenn bestimmte Ereignisse auftreten. Anstatt eine API ständig nach Änderungen abzufragen, ermöglichen Webhooks es Anwendungen, sofortige Updates zu erhalten, wenn ein relevantes Ereignis stattfindet.

Beispiele für die Verwendung von Webhooks sind:

• Zahlungsbenachrichtigungen: Ein Zahlungs-Gateway kann eine Webhook-Benachrichtigung an eine E-Commerce-Anwendung senden, wenn eine Zahlung erfolgreich verarbeitet wurde oder fehlschlägt.
• System-Warnungen: Ein Monitoring-Service kann Webhooks verwenden, um ein DevOps-Team zu benachrichtigen, wenn ein Server ausfällt oder ein Fehler auftritt.
• Datensynchronisation: Ein CRM-System kann Webhooks verwenden, um eine Marketing-Automatisierungsplattform zu aktualisieren, wenn sich die Informationen eines Kunden ändern.

Webhooks sind besonders nützlich für Anwendungen, die Echtzeit-Updates und effiziente Kommunikation zwischen verschiedenen Systemen benötigen.

HTTP-Methoden

HTTP-Methoden, auch HTTP-Verben genannt, zeigen die Aktion an, die an der angegebenen Ressource ausgeführt werden soll. Die am häufigsten verwendeten HTTP-Methoden bei API-Anfragen sind:

• GET: Ruft eine Ressource vom Server ab. GET-Anfragen sollten nur zum Lesen von Daten verwendet werden und diese nicht ändern.
• POST: Erstellt eine neue Ressource auf dem Server. Die Daten für die neue Ressource werden im Request-Body gesendet.
• PUT: Aktualisiert eine vorhandene Ressource auf dem Server. Die aktualisierten Daten werden im Request-Body gesendet.
• DELETE: Löscht eine Ressource vom Server.

Headers

Header liefern zusätzliche Informationen über die Anfrage und die erwartete Antwort. Einige häufig verwendete Header sind:

• User-Agent: Identifiziert die Client-Anwendung, die die Anfrage stellt, z. B. den Namen und die Version der Software.
• Content-Type: Gibt das Format der im Request-Body gesendeten Daten an, z. B. JSON oder XML.
• Accept: Gibt das gewünschte Format der Antwortdaten an und ermöglicht es dem Client, seine Präferenz zu zeigen.

Request-Body

Der Request-Body enthält die Daten, die vom Client an den Server gesendet werden. Er wird hauptsächlich bei POST- und PUT-Anfragen verwendet, um die Daten zu senden, die zum Erstellen oder Aktualisieren einer Ressource benötigt werden. Das Format des Request-Body ist normalerweise JSON oder XML, und der Content-Type-Header sollte entsprechend gesetzt werden.

API-Schlüssel und Access-Token

API-Schlüssel und Access-Token werden für Authentifizierungs- und Autorisierungszwecke verwendet. Sie sind eindeutige Kennungen, die Clients basierend auf ihren zugewiesenen Berechtigungen Zugriff auf die API gewähren. API-Schlüssel und Access-Token helfen sicherzustellen, dass nur autorisierte Clients auf die API und ihre Ressourcen zugreifen können.

Neben der Authentifizierung können API-Schlüssel und Access-Token auch verwendet werden, um die API-Nutzung für Abrechnungs- und Überwachungszwecke zu verfolgen. Dies ermöglicht es API-Anbietern, Rate-Limits durchzusetzen, Nutzungsmuster zu überwachen und Clients basierend auf ihrer Nutzung von API-Ressourcen abzurechnen.

Durch die Einbeziehung dieser Komponenten in eine API-Anfrage können Clients gut mit der API kommunizieren, die gewünschte Aktion angeben, notwendige Daten bereitstellen und einen sicheren und autorisierten Zugriff auf die Ressourcen der API gewährleisten.

Den API-Endpunkt finden

Der erste Schritt beim Durchführen eines API-Aufrufs besteht darin, die URI oder URL des Servers oder Programms zu finden, von dem Sie Daten abrufen möchten. Diese Informationen sind normalerweise in der API-Dokumentation verfügbar, die vom API-Anbieter bereitgestellt wird. Die Dokumentation enthält auch eine Liste der verfügbaren Endpunkte und was jeder Endpunkt tut.

Wenn Sie beispielsweise die GitHub-API verwenden möchten, um Informationen über einen Benutzer abzurufen, würden Sie in der Dokumentation nachsehen und den Endpunkt für Benutzerinformationen finden: https://api.github.com/users/{username}.

Die Anfrage formulieren

Sobald Sie den Endpunkt haben, müssen Sie die API-Anfrage erstellen. Dies umfasst mehrere Komponenten:

1. HTTP-Methode: Geben Sie die Aktion an, die Sie an der Ressource ausführen möchten, indem Sie eine HTTP-Methode wie GET, POST, PUT oder DELETE verwenden. Um beispielsweise Benutzerinformationen von der GitHub-API abzurufen, würden Sie die GET-Methode verwenden.

2. Header: Fügen Sie Header hinzu, um der API mehr Kontext über Ihre Anfrage und das erwartete Antwortformat zu geben. Häufig verwendete Header sind:

   • Content-Type: Gibt das Format der Anfragedaten an, wie JSON oder XML.
   • Accept: Gibt das gewünschte Format für die Antwortdaten an.
   • Authorization: Enthält Authentifizierungs-Token wie API-Schlüssel oder Access-Token.

3. API-Schlüssel oder Access-Token: Viele APIs erfordern eine Authentifizierung, um sicherzustellen, dass nur autorisierte Clients auf die Daten zugreifen können. Fügen Sie Ihren API-Schlüssel oder Ihr Access-Token in die Anfrage ein, entweder in den Headern oder als Query-Parameter.

4. Parameter: Einige API-Endpunkte ermöglichen es Ihnen, Parameter anzugeben, um bestimmte Daten abzurufen oder bestimmte Aktionen auszuführen. Diese können in der URL als Query-Parameter oder im Request-Body für POST- und PUT-Anfragen enthalten sein.

Hier ist ein Beispiel für eine vollständige API-Anfrage zum Abrufen von Informationen über einen GitHub-Benutzer:

GET /users/octocat HTTP/1.1
Host: api.github.com
Authorization: token my_access_token
Accept: application/vnd.github.v3+json

Die API-Anfrage senden

Um die API-Anfrage zu senden, können Sie eine HTTP-Client-Bibliothek in Ihrer bevorzugten Programmiersprache oder ein Tool verwenden, das für API-Anfragen entwickelt wurde.

Beliebte HTTP-Client-Bibliotheken sind:

• Axios für JavaScript
• Requests für Python
• OkHttp für Java

Diese Bibliotheken vereinfachen den Prozess des Erstellens und Sendens von API-Anfragen sowie der Verarbeitung der Antworten.

Sie können auch Tools wie Postman oder cURL verwenden, um API-Anfragen durchzuführen. Diese sind besonders nützlich für Test- und Entwicklungszwecke, da sie es Ihnen ermöglichen, API-Anfragen und -Antworten einfach zu erstellen, zu senden und zu analysieren.

Die API-Antwort verarbeiten

Nach dem Senden der API-Anfrage erhalten Sie eine Antwort vom API-Server. Die Antwort enthält einen Statuscode, der anzeigt, ob die Anfrage erfolgreich war oder nicht, und die angeforderten Daten (falls vorhanden) im angegebenen Format (normalerweise JSON oder XML).

Häufige Statuscodes sind:

• 2XX-Codes (wie 200 OK) für erfolgreiche Anfragen
• 4XX-Codes (wie 404 Not Found) für Client-Fehler
• 5XX-Codes (wie 500 Internal Server Error) für Server-Fehler

Hier ist ein Beispiel für eine Antwort von der GitHub-API für eine erfolgreiche Benutzerinformationsanfrage:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "login": "octocat",
  "id": 1,
  "node_id": "MDQ6VXNlcjE=",
  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
  "gravatar_id": "",
  "url": "https://api.github.com/users/octocat",
  "html_url": "https://github.com/octocat",
  ...
}

In Ihrer Anwendung müssen Sie die Antwort verarbeiten, den Statuscode überprüfen, um zu sehen, ob die Anfrage erfolgreich war, und die zurückgegebenen Daten parsen, um sie in Ihrer Anwendung zu verwenden.

Wenn Sie diese Schritte und Komponenten für API-Aufrufe verstehen, können Sie damit beginnen, Daten und Funktionen von externen Diensten in Ihre eigenen Anwendungen zu integrieren.

Bedeutung von API-Tests

Das Testen von APIs auf Funktionalität, Zuverlässigkeit, Performance und Sicherheit ist wichtig, um sicherzustellen, dass die API die Anforderungen der Anwendung und der Benutzer erfüllt. Gründliche Tests helfen dabei, Bugs, Performance-Engpässe und Sicherheitslücken frühzeitig im Entwicklungsprozess zu finden und das Risiko von Problemen in Produktionsumgebungen zu reduzieren.

API-Tests überprüfen auch, ob die API korrekt auf verschiedene Arten von Anfragen reagiert, einschließlich gültiger und ungültiger Eingaben, und Fehler richtig behandelt. Durch das Testen verschiedener Szenarien können Entwickler sicherstellen, dass die API robust ist und reale Anwendungsfälle bewältigen kann.

Wie man API-Aufrufe testet

Um API-Aufrufe zu testen, können Entwickler Software-Tools oder Webservices wie Postman oder cURL verwenden. Diese Tools ermöglichen es Entwicklern, API-Aufrufe an verschiedene Endpunkte durchzuführen, Anfrageparameter anzupassen und die API-Antworten zu analysieren.

Der allgemeine Prozess zum Testen von API-Aufrufen umfasst die folgenden Schritte:

1. Geben Sie die URL des API-Endpunkts ein, den Sie testen möchten.
2. Wählen Sie die entsprechende HTTP-Methode (GET, POST, PUT, DELETE) basierend auf der Aktion aus, die Sie ausführen möchten.
3. Geben Sie alle notwendigen Authentifizierungsdaten an, wie API-Schlüssel oder Access-Token, und setzen Sie die erforderlichen Header.
4. Fügen Sie alle erforderlichen oder optionalen Parameter in die Anfrage ein, entweder als Query-Parameter in der URL oder als Teil des Request-Body.
5. Senden Sie die API-Anfrage ab und untersuchen Sie die vom API-Server erhaltene Antwort.
6. Analysieren Sie den zurückgegebenen Statuscode, die Antwortzeit und den Inhalt des Response-Body, um zu überprüfen, dass sich die API wie erwartet verhält.

Durch Wiederholen dieser Schritte für verschiedene API-Endpunkte, Anfragetypen und Eingabewerte können Entwickler die API gründlich testen und ihre Qualität überprüfen.

Arten von API-Tests

Es gibt verschiedene Arten von API-Tests, die Entwickler durchführen können, um die Zuverlässigkeit, Performance und Sicherheit der API zu überprüfen:

1. Funktionstests: Diese Art von Tests überprüft, ob die API wie erwartet funktioniert und die korrekten Daten zurückgibt. Entwickler testen verschiedene API-Endpunkte mit unterschiedlichen Eingabewerten und vergleichen die tatsächlichen Antworten mit den erwarteten Ergebnissen. Funktionstests helfen sicherzustellen, dass die API die festgelegten Anforderungen erfüllt und sich konsistent verhält.

2. Performance-Tests: Performance-Tests messen die Antwortzeit, den Durchsatz und die Ressourcennutzung der API unter verschiedenen Bedingungen, wie z. B. hohem Traffic oder großen Datenmengen. Diese Art von Tests hilft dabei, Performance-Engpässe zu finden, die Effizienz der API zu optimieren und sicherzustellen, dass sie die erwartete Last bewältigen kann.

3. Sicherheitstests: Sicherheitstests konzentrieren sich darauf, Schwachstellen zu finden und sicherzustellen, dass die API gegen gängige Angriffe wie SQL-Injection, Cross-Site-Scripting (XSS) und Autorisierungs-Bypass geschützt ist. Entwickler testen die Authentifizierungs- und Autorisierungsmechanismen der API, validieren Eingabedaten und prüfen auf ordnungsgemäße Fehlerbehandlung, um Sicherheitsrisiken zu minimieren.

4. Zuverlässigkeitstests: Zuverlässigkeitstests überprüfen die Fähigkeit der API, Fehler, Grenzfälle und unerwartete Eingaben korrekt zu behandeln. Dies umfasst das Testen auf ordnungsgemäße Fehlerantworten, Timeouts und die Fähigkeit der API, sich von Ausfällen zu erholen. Zuverlässigkeitstests helfen sicherzustellen, dass die API auch in Ausnahmesituationen stabil und vorhersehbar bleibt.

Durch die Durchführung dieser verschiedenen Arten von Tests können Entwickler überprüfen, ob die API die erforderlichen Qualitätsstandards erfüllt und ihren Benutzern einen zuverlässigen, performanten und sicheren Service bietet.

Einen Flug buchen

Wenn Sie eine Reise-Website verwenden, um einen Flug zu buchen, interagiert die Website oft mit der API der Fluggesellschaft, um Echtzeit-Informationen über verfügbare Flüge zu erhalten. So könnte der Prozess ablaufen:

1. Sie geben Ihre gewünschten Reisedaten, den Abflughafen und das Ziel auf der Reise-Website ein.
2. Die Reise-Website sendet eine GET-Anfrage an den API-Endpunkt der Fluggesellschaft und übergibt Ihre Suchparameter als Teil der URL oder als Query-Parameter.
3. Der API-Server der Fluggesellschaft empfängt die Anfrage, durchsucht seine Datenbank nach Flügen, die Ihren Kriterien entsprechen, und sendet eine Antwort zurück, die eine Liste der verfügbaren Flüge zusammen mit Informationen wie Preisen, Abflug- und Ankunftszeiten und Flugnummern enthält.
4. Die Reise-Website parst die API-Antwort und zeigt Ihnen die verfügbaren Flüge an, sodass Sie Ihren gewünschten Flug auswählen und buchen können.

Durch die Verwendung von API-Aufrufen kann die Reise-Website Ihnen aktuelle Fluginformationen bereitstellen, ohne eine eigene Datenbank mit Flügen pflegen zu müssen.

In sozialen Medien posten

Social-Media-Plattformen wie Facebook, Twitter und Instagram bieten APIs an, die es Drittanbieter-Anwendungen ermöglichen, mit ihren Diensten zu interagieren. Wenn Sie über eine App etwas auf einer Social-Media-Plattform posten, verwendet die App die API der Plattform, um Ihren Beitrag an die Server der Plattform zu senden. So funktioniert es:

1. Sie verfassen einen neuen Beitrag in der App, der Text, Bilder oder Videos enthalten kann.
2. Wenn Sie den Beitrag absenden, sendet die App eine POST-Anfrage an den API-Endpunkt der Social-Media-Plattform. Die Anfrage enthält den Inhalt Ihres Beitrags und alle notwendigen Authentifizierungs-Token.
3. Der API-Server empfängt die Anfrage, überprüft Ihre Authentifizierung und verarbeitet die Beitragsdaten.
4. Wenn der Beitrag gültig ist, speichert der API-Server den neuen Beitrag in seiner Datenbank und sendet eine Antwort an die App zurück, die anzeigt, dass der Beitrag erfolgreich erstellt wurde.
5. Die App erhält die Antwort und zeigt Ihnen eine Bestätigungsnachricht an.

Durch die Verwendung der API der Social-Media-Plattform kann die App Ihnen ermöglichen, Beiträge zu erstellen, ohne eine eigene Backend-Infrastruktur zum Speichern und Verarbeiten von Beitragsdaten aufbauen zu müssen.

Zahlungen verarbeiten

Wenn Sie auf einer E-Commerce-Website einen Kauf tätigen, verwendet die Website oft die API eines Zahlungs-Gateways, um Ihre Zahlung sicher zu verarbeiten. Hier ist ein Beispiel, wie der Zahlungsprozess ablaufen könnte:

1. Sie wählen die Artikel aus, die Sie kaufen möchten, und gehen zur Checkout-Seite auf der E-Commerce-Website.
2. Sie geben Ihre Zahlungsdetails ein, wie z. B. Ihre Kreditkartennummer und Rechnungsadresse.
3. Wenn Sie das Zahlungsformular absenden, sendet die E-Commerce-Website eine POST-Anfrage an den API-Endpunkt des Zahlungs-Gateways. Die Anfrage enthält Ihre Zahlungsdetails und den zu belastenden Gesamtbetrag.
4. Der API-Server des Zahlungs-Gateways empfängt die Anfrage und kommuniziert sicher mit dem Zahlungsanbieter (wie z. B. dem Kreditkartenunternehmen), um die Transaktion zu verarbeiten.
5. Wenn die Zahlung genehmigt wird, sendet das Zahlungs-Gateway eine Antwort an die E-Commerce-Website zurück, die anzeigt, dass die Zahlung erfolgreich war. Wenn die Zahlung abgelehnt wird, sendet die API eine Fehlerantwort zurück.
6. Die E-Commerce-Website erhält die API-Antwort und zeigt Ihnen eine Bestätigungsnachricht an, die Sie darüber informiert, ob die Zahlung erfolgreich verarbeitet wurde.

Durch die Verwendung der API eines Zahlungs-Gateways kann die E-Commerce-Website Zahlungen sicher verarbeiten, ohne sensible Zahlungsinformationen direkt handhaben zu müssen.

Dies sind nur einige Beispiele dafür, wie API-Aufrufe in realen Anwendungen verwendet werden. APIs ermöglichen es verschiedenen Softwaresystemen, nahtlos zu kommunizieren und Daten auszutauschen, wodurch es möglich wird, komplexe Anwendungen zu erstellen, die die Funktionen mehrerer Dienste nutzen.