Was bedeutet API?

Eine API, kurz für Application Programming Interface, bezeichnet eine Reihe von Funktionscodes, die es Anwendungen ermöglichen, auf bestimmte Daten zuzugreifen und mit externen Softwareanwendungskomponenten, Betriebssystemen oder Mikrodiensten zu interagieren.

Vereinfacht ausgedrückt liefert eine API eine Benutzerantwort an ein System und sendet die Antwort des Systems an einen Benutzer zurück. Sie klicken auf „In den Warenkorb“; Eine API teilt der Website mit, dass Sie ein Produkt zu Ihrem Warenkorb hinzugefügt haben. Die Website legt das Produkt in Ihren Warenkorb und Ihr Warenkorb wird aktualisiert.

Möglicherweise fällt im Zusammenhang mit der API der Begriff „Microservices“. Diese sind jedoch nicht gleich. Microservices sind ein Stil oder eine Architektur, die die Funktionalität innerhalb einer Webanwendung aufteilt. Während API das Framework ist, über das Entwickler mit einer Webanwendung interagieren. Microservices können tatsächlich Verwenden Sie API, um zu kommunizieren zwischen einander.

Mit der API kann ein Entwickler einen bestimmten „Aufruf“ oder eine „Anfrage“ tätigen, um Informationen zu senden oder zu empfangen. Diese Kommunikation erfolgt mithilfe einer Programmiersprache namens „JSON“. Es kann auch verwendet werden, um eine definierte Aktion durchzuführen, z. B. das Aktualisieren oder Löschen von Daten. Es gibt vier grundlegende Anforderungsmethoden, die mit der API durchgeführt werden können:

GET – Sammelt Informationen (ruft alle Gutscheincodes ab)

PUT – Aktualisiert Daten (Aktualisierung der Produktpreise)

POST – Erstellt (Erstellen einer neuen Produktkategorie)

LÖSCHEN – (Löschen eines Blogbeitrags)

Was ist JSON und warum wird es verwendet?

JSON (JavaScript Object Notation) wird zur Darstellung von Daten auf einem Server verwendet. Es ist für Menschen relativ einfach zu lesen und für Maschinen/Anwendungen leicht zu verstehen. Schauen wir uns ein Beispiel für JSON aus einem Produkt bei BigCommerce an:

Dies ist leicht zu verstehen, da die Ausgabe in Schlüssel/Wert-Paaren erfolgt, mit dem Schlüssel auf der linken Seite und einem Wert auf der rechten Seite. Schlüssel sind ein festes, von der Anwendung definiertes Objekt und bleiben die gleichen wie bei „Kategorie“. Die Werte hingegen werden eindeutig sein, wie zum Beispiel „Hemden“.

Was ist eine API-Anfrage?

Eine API-Anfrage besteht aus mehreren Komponenten, damit sie funktioniert. Sehen wir uns diese einzeln an und wie sie zum Erstellen einer Anfrage verwendet werden können.

Was ist Endpunkt?

Es gibt zwei Schlüsselteile eines Endpunkts, die beim Stellen einer API-Anfrage verwendet werden. Eine davon ist die URL. BigCommerce verwendet https://api.bigcommerce.com/stores/ als URL für alle API-Anfragen. Dies mag wie eine normale URL aussehen, aber wenn Sie diese in einen Webbrowser einbinden, erhalten Sie eine 404-Fehlermeldung.

Der zweite Teil ist der Weg. Der Weg variiert je nachdem, was Sie erreichen möchten. Eine Liste der verfügbaren Pfade für BigCommerce finden Sie in unserer Entwicklerdokumentation: https://developer.bigcommerce.com/api-reference. Für dieses Beispiel verwenden wir den Produktpfad /v3/catalog/products.

Wenn wir diese beiden Teile zusammenfügen, erhalten wir einen vollständigen Endpunkt https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products. Jetzt fragen Sie sich vielleicht: „Was ist der {store_hash}?“ „Wo kommt das her?“ Dies ist eine sogenannte Variable. Variablen sind einzigartige Komponenten eines Endpunkts und variieren je nach den Informationen Ihres Shops. Sie können eine Variable an den offenen und geschlossenen Klammern „{ }“ erkennen.

Was ist Header?

Header stellen dem Client und Server Informationen zur Verfügung. Gängige Beispiele für einen Header wären Authentifizierungsdaten wie ein „Auth-Token“ oder eine „Client-ID“. Diese Anmeldeinformationen werden Ihnen automatisch bereitgestellt, wenn Sie ein API-Konto erstellen. Ein weiterer gebräuchlicher Header wird als „Content Type“ bezeichnet und informiert den Server darüber, welche Art von Inhalt gesendet wird. Ein häufig verwendeter Inhaltstyp ist beispielsweise „application/json“, der dem Server mitteilt, dass wir JSON-Daten senden.

Was ist Methode?

Methoden sind die Aktionen, die beim Senden einer Anfrage ausgeführt werden. Denken Sie an den Anfang zurück, als wir über GET, PUT, POST und DELETE gesprochen haben. Dies sind alles API-Methoden.

Was sind Daten?

Bei den Anforderungsdaten, die im Allgemeinen auch als „Körper“ bezeichnet werden, handelt es sich um Informationen, die entweder an einen Server gesendet oder von diesem zurückgegeben werden. In der vorherigen Diskussion von JSON können Sie ein Beispiel für API-Daten sehen. Der Hauptteil einer Anfrage erfordert manchmal spezifische Informationen, bevor sie zugestellt werden kann. Wenn Sie beispielsweise ein einzelnes Produkt bearbeiten, ist die Produkt-ID erforderlich, bevor Änderungen vorgenommen werden können.

Lesen Sie weiter hier.