WordPress-APIs: Was sind sie und wie werden sie verwendet?

Die WordPress JSON REST API hat in der WordPress-Community für großes Aufsehen gesorgt und bietet sowohl Entwicklern als auch Content-Erstellern neue Möglichkeiten.

Auch wenn es komplex klingen mag, kann das Verständnis von Schlüsselbegriffen wie JSON, REST und API die Interaktion mit den vielfältigen Funktionen von WordPress vereinfachen.

Was ist eine API?

API steht für „Application Programming Interface“ und ist im Wesentlichen eine Reihe von Programmieranweisungen und Standards, die es verschiedenen Softwareanwendungen ermöglichen, miteinander zu kommunizieren.

Stellen Sie sich vor, dass eine Softwareanwendung einer anderen Anweisungen gibt – eine API ist der Satz vereinbarter Regeln, die diese Interaktion regeln. Wenn eine Software Anweisungen an eine andere sendet, erleichtert die API die Aktion oder stellt die erforderlichen Informationen bereit.

Sie können sich eine API als „Benutzerschnittstelle“ zwischen zwei Softwaresystemen vorstellen, die die Kommunikation von Daten und die Aufgabenausführung übernimmt, für den Endbenutzer jedoch unsichtbar ist.

Beispiele für APIs

Der Zugriff auf eine API ist bei der Entwicklung von Webanwendungen großartig. Wenn eine API für die Öffentlichkeit freigegeben wird, bedeutet dies, dass die Entwickler Lösungen erstellt haben, die auf dem Dienst der Software basieren. Oftmals machen sie es für viele Aufgaben überflüssig, das Rad neu zu erfinden, da sie bereits erstellt wurden.

Ein großartiges Beispiel für eine API ist Amazon. Amazon hat seine API veröffentlicht, damit Entwickler problemlos auf Produkte und deren Informationen zugreifen können. Durch den Zugriff darauf können Sie ganz einfach Links zu Produkten auf Amazon veröffentlichen, mit aktualisierten Preisen und der Kaufoption.

Ein weiteres Beispiel für die Interaktion von APIs wäre der Kauf von Konzertkarten. Um Tickets offiziell zu kaufen, müssen Sie Ihre Kreditkarteninformationen eingeben. Über eine API werden Ihre Kreditkarteninformationen an eine Remote-Anwendung gesendet, die dann überprüft, ob die Kreditkarteninformationen korrekt sind.

Sobald alles überprüft wurde, sendet die Remote-Anwendung eine Antwort an die Ticket-Website zurück und teilt mit, dass der Vorgang in Ordnung sei. An diesem Punkt haben Sie die Tickets erfolgreich gekauft. Wenn das alles passiert, sehen Sie nur eine Schnittstelle, nämlich die Ticket-Website. Es ist ein nahtloser Prozess; Hinter den Kulissen arbeiten viele Anwendungen über APIs zusammen, aber Sie als Benutzer bemerken nicht, wenn Aufgaben von einer Anwendung an eine andere übergeben werden.

APIs und WordPress

Amazon und Ticketkäufe sind großartige Beispiele dafür, wie APIs zusammenarbeiten, aber wie trifft das auf WordPress zu?

Nun, es gelten die gleichen Ideen. Mit der WordPress-API können Sie Daten in und aus WordPress übertragen und abrufen.

Die API ist ein wichtiges Tool, mit dem Entwickler problemlos Daten von ihrer WordPress-Website an andere Websites oder Anwendungen weitergeben können. Mit dieser API können Sie insbesondere CRUD-Aktionen ( create , read , update und delete ) für WordPress-Inhalte ausführen. Einige Beispiele für die Inhaltstypen sind:

• Beiträge
• Benutzerdefinierte Beitragstypen
• Seiten
• Taxonomien
• Benutzer
• Medien

Was bedeutet REST?

Hier gibt es kein Nickerchen oder Schnarchen – REST bezieht sich auf den Architekturstil einer API. REST steht für Representational State Transfer.

Erinnern Sie sich, wie wir erwähnt haben, dass eine API die Einzelheiten für die Kommunikation bereitstellt, damit Programme miteinander kommunizieren können? REST-APIs sind so konzipiert, dass sie eine einfache Kommunikationsmethode bieten, die Bandbreite spart. Genau dies leistet die WordPress JSON REST API, was sie zu einer großartigen Option bei großen Datenmengen macht.

Wir haben gerade erst an der Oberfläche von REST gekratzt; Wenn Sie mehr erfahren möchten, schauen Sie sich dieses hilfreiche REST-Tutorial an.

JSON-Format

Um auf Daten zugreifen zu können, benötigen wir eine Quelle, aus der wir schöpfen können. Hier kommt JSON ins Spiel. JSON steht für JavaScript Object Notation.

JSON ist sowohl für Menschen als auch für Maschinen leicht zu lesen und zu verstehen. Es ist die perfekte Möglichkeit, Informationen organisiert und leicht zugänglich zu speichern. Da der Zugriff auf JSON so einfach ist, eignet es sich hervorragend für die Erstellung von REST-APIs und ist die perfekte Lösung für die WordPress-JSON-REST-API.

Hier ist eine grundlegende Vorstellung davon, wie das JSON-Format aussieht:

[Javascript]
{"Mitarbeiter":[
{„firstName“:“Jane“, „lastName“:“Smith“},
{„Vorname“: „Anna“, „Nachname“: „Olsen“},
{„Vorname“: „Josh“, „Nachname“: „Jones“}
]}

[/javascript]

JSON-Format in WordPress

JSON schreibt sich nicht einfach selbst, aber keine Sorge, Sie müssen die JSON-Datei nicht manuell erstellen. Es gibt Plugins, die es für Sie erstellen können. Mit einem dieser Tools liegen die Daten der Website im richtigen Format vor, einschließlich Benutzern, Beiträgen, Seiten, Taxonomien und mehr.

Verwendung der JSON REST API

Die Verwendung der API ist ziemlich selbsterklärend; Sie erhalten die Daten Ihrer Website im einfachen JSON-Format. Und wenn Sie ein Plugin installiert haben, können Sie damit experimentieren, die Beiträge Ihrer Website in Datenform anzuzeigen.

Das Abrufen oder Aktualisieren von Daten ist so einfach wie das Senden einer HTTP-Anfrage. HTTP ist ein Anfrage/Antwort-Protokoll. Zuerst senden Sie eine Datenanfrage und dann werden die Daten als Antwort zurückgesendet.

GET-Methode

Die GET-Methode wird zum Abrufen von Informationen verwendet und hat keine Auswirkung auf die Daten. Senden Sie einfach eine GET-Anfrage an /wp-json/wp/v2/posts . Möchten Sie etwas suchen? Wenn Sie beispielsweise nach „Entwicklung“ suchen, erhalten Sie die Ergebnisse mit der GET-Anfrage /wp-json/wp/v2/posts?search=development .

POST-Anfrage

Zum Senden von Daten wird eine POST-Anfrage verwendet. Mit den Funktionen der neuen API könnten Sie beispielsweise einen Benutzer aktualisieren. Nehmen wir an, Sie möchten den Benutzer mit der ID 10 aktualisieren. Sie müssen lediglich eine POST-Anfrage an /wp-json/wp/v2/users/10 senden.

Um dies auszuprobieren, empfehlen wir die Verwendung von Postman, einer Google Chrome-Erweiterung.

Mehr Javascript im Mix

Backbone.js und APIs

Backbone.js ist eine großartige Möglichkeit, mit der API zu arbeiten, da es sich um ein Framework handelt, das für die Arbeit mit REST-APIs entwickelt wurde. Die WordPress-API umfasst eine benutzerfreundliche Javascript-API basierend auf Backbone-Modellen. Dadurch können Plugin- und Theme-Entwickler ohne große Anstrengungen und Kenntnisse über die Details der Verbindung loslegen.

Es steckt noch viel mehr dahinter, aber Backbone gibt Webanwendungen Struktur, indem es Modelle, Sammlungen und Ansichten bereitstellt und alles über eine REST-JSON-Schnittstelle mit der WordPress-API verbindet.

Was bedeutet das für WordPress-Entwickler?

Mit der Verfügbarkeit der WordPress-API haben sich neue Möglichkeiten der Nutzung ergeben und werden dies auch weiterhin tun, da sie immer beliebter wird. Die WordPress-API kann nahezu jede bestehende WordPress-Funktionalität verbessern, die auf Javascript basiert. Hier ein paar Beispiele:

• Formularvalidierung/-Übermittlung
• Backbone.js-Themen oder Plugins
• unendliches Scrollen

Es ist auch eine großartige Möglichkeit, Inhalte aus anderen Quellen anzuzeigen. Jetzt ist es einfach, Inhalte einer einzelnen Site in einem Multisite-Setup anzuzeigen. Es ist auch möglich, Inhalte von einer völlig separaten WordPress-Site anzuzeigen. Neben der Anzeige von Inhalten können diese auch einfacher und effektiver aktualisiert werden.

Nachdem wir nun einige der grundlegenden Terminologie durchgegangen sind, wissen wir, dass JSON die Notation, REST der Architekturstil und API die Schnittstelle ist, aus der sie bestehen. Wenn Sie die Grundlagen der API und ihrer Funktionen kennen, haben Sie einen guten Start, wenn Sie die neuen Möglichkeiten mit der WordPress-API erkunden.