Wofür steht API? Eine Definition des Codierungsakronyms in Plain English.

Nein, API steht nicht für Apple Pie Inside. ?? API steht für Application Programming Interface. Mithilfe von APIs können zwei Anwendungen miteinander kommunizieren (oder interagieren).

Eine API eine Reihe von Programmieranweisungen und Funktionen, die für den Zugriff auf eine Website oder eine webbasierte Softwareanwendung verwendet werden. Mit einer API können andere Entwickler die Daten und Funktionen Ihrer Anwendung verwenden. Es ermöglicht Ihrem Produkt, mit anderen Produkten zu interagieren.

APIs wurden erstmals in den 1980er Jahren in der Software- und Hardwareentwicklung eingesetzt. Wenn die Leute jetzt über APIs sprechen, beziehen sie sich normalerweise auf Web-APIs oder genauer gesagt auf RESTful-APIs. Es ist gängige Praxis, bei der Entwicklung webbasierter Anwendungen RESTful-APIs zu verwenden.

Eine Web-API ist im Grunde ein Programm, mit dem Sie vollständig über URLs interagieren. Normalerweise sendet ein Server beim Senden einer Anfrage an eine URL mit Ihrem Browser eine Antwort zurück, die angezeigt wird, damit Sie sie anzeigen können. Anders sieht es aus, wenn Sie eine Anfrage an eine URL einer API senden. Der Server sendet etwas zurück, das nur für den Computer nützlich sein soll. Eine API gibt Daten zurück, die auf einer anderen Website oder in einem anderen Programm verwendet werden können.

Wofür werden APIs verwendet?

APIs dürfen nicht von Endbenutzern verwendet werden. Sie werden verwendet, damit Software mit anderer Software interagiert. Beispielsweise kann eine Website die Open Weather-API aufrufen, um Wetterinformationen auf der Website anzuzeigen.

APIs werden manchmal auch intern in einem einzelnen Unternehmen verwendet. Sie können verwendet werden, um interne Websites und Systeme zu erstellen, die leicht miteinander interagieren können.

Wie funktioniert eine API?

Eine API ermöglicht anderen im Allgemeinen den Zugriff auf eine große Menge organisierter Daten. Der Gatekeeper dieser Daten erteilt einem Entwickler die Erlaubnis (in Form eines API-Schlüssels ), einen Server um Informationen zu bitten. Wenn die Anforderung erfolgreich ist, antwortet der Server mit einer Nachricht, normalerweise im JSON- oder XML-Format.

Normalerweise gibt es eine Dokumentation für eine API, die Sie verwenden möchten, die als API-Spezifikation bezeichnet wird. Hier werden die Steuerelemente und die Verwendung der API erläutert.

Hier ist ein Beispiel für die API-Spezifikation für die OpenWeather-API, mit der Sie das aktuelle Wetter an einem bestimmten Ort abrufen können: //openweathermap.org/current

API-Spezifikationen enthalten eine Liste von URLs, mit denen Sie Daten abrufen können. Die Verwendung einer der URLs wird als API-Anforderung oder API-Aufruf bezeichnet . Oft zeigt die Spezifikation Parameter und die Antwort für jede URL, die Teil der API ist.

Parameter

Parameter sind das, was Sie am Ende einer URL hinzufügen, um anzugeben, welche Informationen die API zurückgeben soll. Parameter sind im Grunde genommen Variablen, die Sie an die API übergeben.

Die URL zum Abrufen von Wetterinformationen von der OpenWeather-API lautet:

api.openweathermap.org/data/2.5/weather.

Sie müssen jedoch eine Stadt als Parameter hinzufügen, um anzugeben, für welchen Ort Wetterdaten zurückgegeben werden sollen. Hier ist die URL mit dem Stadtparameter:

api.openweathermap.org/data/2.5/weather?q=London

Manchmal sind Parameter erforderlich, um eine Antwort zu erhalten. Manchmal sind Parameter optional. In der OpenWeather-API muss ein Standort angegeben werden. Neben dem Namen der Stadt gibt es jedoch auch andere Möglichkeiten, den Standort anzugeben. Alle Möglichkeiten sind in der API-Spezifikation angegeben.

Parameter können auch Folgendes angeben:

  • Wie sollen die Ergebnisse sortiert werden?
  • Wie viele Ergebnisse sollten zurückgegeben werden?
  • In welchem ​​Format sollten die Ergebnisse vorliegen?
  • Für welchen Zeitraum möchten Sie Ergebnisse erzielen?

Die Antwort

Wenn Sie eine Anfrage an eine API senden, erhalten Sie eine Antwort zurück. Sie erhalten entweder die von Ihnen angeforderten Daten oder einen Grund zurück, warum die Anforderung fehlgeschlagen ist.

Unten finden Sie ein Beispiel für eine Antwort, die Sie erhalten, wenn Sie die folgende Anfrage senden : api.openweathermap.org/data/2.5/weather?q=London. Es ist eine JSON-Antwort.

{ "coord": { "lon": -0.13, "lat": 51.51 }, "weather": [ { "id": 300, "main": "Drizzle", "description": "light intensity drizzle", "icon": "09d" } ], "base": "stations", "main": { "temp": 280.32, "pressure": 1012, "humidity": 81, "temp_min": 279.15, "temp_max": 281.15 }, "visibility": 10000, "wind": { "speed": 4.1, "deg": 80 }, "clouds": { "all": 90 }, "dt": 1485789600, "sys": { "type": 1, "id": 5091, "message": 0.0103, "country": "GB", "sunrise": 1485762037, "sunset": 1485794875 }, "id": 2643743, "name": "London", "cod": 200 }

Eine API-Antwort ist möglicherweise nicht wie in diesem Beispiel formatiert. Der gesamte Text steht häufig in einer einzigen Zeile. Da es hauptsächlich von einem Computer und nicht von einer Person gelesen werden soll, spielt die Formatierung keine Rolle.

API-Schlüssel

Wenn Sie die obige URL selbst ausprobieren, erhalten Sie die obige Antwort nicht. Es wird wahrscheinlich eher so aussehen:

{ "cod": 401, "message": "Invalid API key. Please see //openweathermap.org/faq#error401 for more info." }

Die meisten APIs erfordern eine Authentifizierung, bevor sie Daten zurückgeben. Dies erfolgt normalerweise in Form eines API-Schlüssels . Diese Schlüssel sind wie ein Passwort. Dies ist eine lange Folge von Buchstaben und Zahlen, die Sie mit Ihrer API-Anfrage senden müssen, damit der Server weiß, dass Sie auf die Informationen zugreifen dürfen.

Für die OpenWeather-API und viele andere APIs können Sie nach dem Erstellen eines Kontos kostenlos einen API-Schlüssel erhalten. Viele Unternehmen verwenden API-Schlüssel für kostenlose APIs, um sicherzustellen, dass nicht viele Anfragen an einem Tag gestellt werden. Es könnte einen Server wirklich zum Erliegen bringen, wenn eine einzelne Person jede Minute Tausende von Anfragen stellt.

Einige APIs sind ohne API-Schlüssel öffentlich. Unten finden Sie eine API, mit der Sie Reimwörter finden können. Klicken Sie auf den Link und versuchen Sie dann, das letzte Wort in der URL zu ändern, um nach verschiedenen Reimwörtern zu suchen.

//api.datamuse.com/words?rel_rhy=camp

Möchten Sie mehr erfahren?

Wenn Sie mehr über die Verwendung von APIs erfahren möchten, sehen Sie sich das folgende Video auf dem YouTube-Kanal von freeCodeCamp.org an.