Einführung in APIs

Willkommen in der großen Welt der APIs!

In diesem Artikel erfahren Sie:* Was eine API ist* Was eine RESTful API ist* Wie man mit den APIs von Tulip arbeitet

Was ist eine API?

Eine API (Application Programming Interface) ist eine Reihe von Protokollen, die es verschiedenen Softwarekomponenten ermöglichen, zu kommunizieren und Daten zu übertragen.

Entwickler verwenden APIs, um die Lücken zwischen kleinen, diskreten Code-Blöcken zu überbrücken, um Anwendungen zu erstellen, die leistungsfähig, belastbar und sicher sind und die Bedürfnisse der Benutzer erfüllen können.

Eine API besteht aus vier Hauptbestandteilen:1. API-Client - wie Sie eine API-Anfrage initiieren können.2. API-Anfrage - eine Anfrage an eine API zur Durchführung einer Aktion oder zur Bereitstellung von Informationen an Sie.3. API-Server - bestätigt, woher die Anfrage kommt, ob die Anfrage wohlgeformt ist, und ruft die angeforderten Daten ab oder bearbeitet sie.4. API-Antwort - die Antwort an Sie (den Client).

API-Anfrage

Eine API-Anfrage besteht aus fünf Hauptbestandteilen:

• Endpunkt: Dies ist eine spezielle URL, die den Zugriff auf eine bestimmte Ressource ermöglicht. Mit dem Endpunkt /tables können Sie zum Beispiel alle Tulip-Tabellen abrufen oder eine neue Tulip-Tabelle erstellen.
• Methode: Dies ist die Art der Operation, die Sie mit der API durchführen möchten. Da Tulip REST-APIs verwendet, sind diese auf GET, PUT, POST und DELETE beschränkt.
• Parameter: Variablen, die an einen API-Endpunkt übergeben werden, um der API spezifische Anweisungen für die Verarbeitung zu geben. In Anlehnung an die vorherigen Beispiele für den /tables-Endpunkt können Sie über /tables/{tableId} eine bestimmte Tabellen-ID angeben. Darüber hinaus gibt es Abfragen, mit denen weitere Parameter geändert werden können.
• Anfrage-Kopfzeilen: Schlüssel-Wert-Paare, die Details über die Anfrage liefern, wie z. B. den Inhaltstyp oder die Authentifizierungsdaten.
• Anfragekörper: Der Hauptteil der Anfrage, in dem angegeben wird, welche Daten zum Erstellen, Aktualisieren oder Löschen einer Ressource erforderlich sind. In der Stations-URL können Sie zum Beispiel eine neue Station erstellen und angeben, zu welcher Stationsgruppe sie gehören soll und welche Anwendungen sie enthalten kann.

API-Antwort

Wenn Sie eine REST-Anfrage erfolgreich zusammengestellt und gesendet haben, antworten die Server mit folgendem:

• Einem Statuscode: Dreistellige Codes, die das Ergebnis einer API-Anfrage anzeigen.
• Antwort-Header: Enthalten zusätzliche Informationen über die Antwort des Servers.
• Antwortkörper: Der Antwortkörper enthält die eigentlichen Daten oder Inhalte, die der Client angefordert hat - oder eine Fehlermeldung, wenn etwas schief gelaufen ist.

Gängige HTTP-Statuscodes sind:

200 OK: Zeigt an, dass die Anfrage erfolgreich war und der Antwortkörper die angeforderte Ressource enthält**.404 Not Found**: Zeigt an, dass der Server die angeforderte Ressource nicht finden kann, oft aufgrund einer falsch eingegebenen URL oder einer Ressource, die verschoben oder gelöscht wurde**.400 Bad Request**: Bedeutet, dass der Server die Anfrage aufgrund eines Client-Fehlers nicht bearbeiten kann, z. B. aufgrund einer ungültigen Syntax oder fehlender erforderlicher Parameter in der Anfrage**.500 Internal Server Error**: Zeigt an, dass der Server auf eine unerwartete Bedingung gestoßen ist, die ihn daran gehindert hat, die Anfrage zu erfüllen, typischerweise ein serverseitiges Problem, das sich der Kontrolle des Clients entzieht**.302 Found (Moved Temporarily): Zeigt an, dass die angeforderte Ressource vorübergehend auf eine andere URL verschoben wurde. Der Client sollte eine weitere Anfrage an die neue URL stellen, die im Antwort-Header angegeben ist.401 Unauthorized**: Bedeutet, dass für die Anfrage eine Benutzerauthentifizierung erforderlich ist, der Client aber keine gültigen Anmeldedaten angegeben hat oder sich noch nicht authentifiziert hat.

Weitere Informationen zu HTTP-Fehlercodes finden Sie hier.

Was ist eine RESTful API?

Tulip verwendet RESTful APIs. Andere Arten von APIs sind SOAP, GraphQL, Webbhooks oder gRPC.

Eine REST-API, auch bekannt als RESTful API, ist eine einfache, einheitliche Schnittstelle, die verwendet wird, um Daten, Inhalte, Algorithmen, Medien und andere digitale Ressourcen über Web-URLs verfügbar zu machen. REST-APIs sind die heute im Web am häufigsten genutzten APIs.

REST-APIs verwenden vier Hauptmethoden:1. GET: Diese Methode ermöglicht es dem Server, die von Ihnen angeforderten Daten zu finden und an Sie zurückzuschicken.2. PUT: Wenn Sie die PUT-Anforderung ausführen, aktualisiert der Server einen Eintrag in der Datenbank.3. POST: Mit dieser Methode kann der Server einen neuen Eintrag in der Datenbank erstellen.4. DELETE: Mit dieser Methode kann der Server einen Eintrag in der Datenbank löschen.

Wie man mit der Tulip API arbeitet

Lesen Sie die folgenden Artikel, um mit der Verwendung und dem Testen von APIs mit Tulip zu beginnen:

• Was sind Konnektoren?
• Wie man eine HTTP-Konnektor-Funktion erstellt und konfiguriert
• Einrichten einer Tulip-API

Haben Sie gefunden, wonach Sie gesucht haben?

Sie können auch auf community.tulip.co Ihre Frage stellen oder sehen, ob andere mit einer ähnlichen Frage konfrontiert wurden!