WordPress-API-Grundlagen: Was es bedeutet und wie man es verwendet

Veröffentlicht: 2016-03-03

Sie haben vielleicht schon von der Begeisterung über die WordPress JSON REST API gehört. Das sind große Neuigkeiten für WordPress-Benutzer und ein Grund zum Feiern!

JSON, REST, API – dies ist jedoch eine Menge Fachjargon für einen Namen, also lassen Sie uns alles aufschlüsseln.

Was ist eine API?

API steht für „Application Programming Interface“, eine Reihe von Programmieranweisungen und Standards für den Zugriff auf eine webbasierte Softwareanwendung oder ein Webtool. Stellen Sie sich „Software eins“ vor, die „Software zwei“ Anweisungen gibt. Eine API ist eine Vereinbarung zwischen den beiden und die Kommunikationswege sind offen. Im Grunde sagen sie einander etwas in der Art von „Wenn Sie mir eine Anweisung geben, werde ich die Aktion ausführen oder die richtigen Informationen zurückgeben.“

Da wir das Internet durchsuchen und verschiedene Softwarelösungen verwenden, sind wir an Benutzeroberflächen mit bestimmten Layouts, Schaltflächen und Grafiken gewöhnt, mit denen wir interagieren, um unsere gewünschten Aufgaben zu erledigen. All dies ist für eine Maschine nutzlos, denn alles, was sie interessiert, sind Daten und was sie tun müssen und wie sie damit interagieren. Eine API ist die Alternative der Software zur „Benutzerschnittstelle“, die einer zweiten Software Anweisungen zum Abrufen von Daten und anderen spezifischen Aufgaben gibt. Sie sind für Benutzer, die die Webanwendung verwenden, völlig unsichtbar und stellen einfach eine Software-zu-Software-Schnittstelle dar.

WordPress-API-Software-zu-Software

Beispiele für APIs

Der Zugriff auf eine API ist großartig, wenn Sie Webanwendungen entwickeln. Wenn eine API für die Öffentlichkeit freigegeben wird, bedeutet dies, dass die Entwickler Lösungen erstellt haben, die vom Dienst der Software unterstützt werden. Oft nehmen sie vielen Aufgaben die Notwendigkeit, das Rad neu zu erfinden, da sie bereits geschaffen wurden.

Ein gutes Beispiel für eine API ist Amazon. Amazon hat seine API veröffentlicht, damit Entwickler einfachen Zugriff auf die Produkte und ihre Informationen haben. Der Zugriff darauf macht es einfach, Links zu Produkten auf Amazon zu posten, 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. Eine API wird verwendet, um Ihre Kreditkarteninformationen an eine Remote-Anwendung zu senden, die dann überprüft, ob die Kreditkarteninformationen korrekt sind. Sobald alles ausgecheckt ist, sendet die Remote-Anwendung eine Antwort an die Ticket-Website zurück, in der sie sagt, dass es in Ordnung ist, fortzufahren. An diesem Punkt haben Sie die Tickets erfolgreich gekauft. Wenn dies alles passiert, sehen Sie nur eine Schnittstelle, nämlich die Ticket-Website. Es ist ein nahtloser Prozess; Hinter den Kulissen arbeiten viele Anwendungen mithilfe von APIs zusammen, aber Sie als Benutzer bemerken nicht, wenn Aufgaben von einer Anwendung an eine andere übergeben werden.

API und WordPress

Amazon und Ticketkäufe sind großartige Beispiele dafür, wie APIs zusammenarbeiten, aber wie gilt das für WordPress?
Nun, es gelten alle die gleichen Ideen. Mit der WordPress-API können Sie Daten aus WordPress pushen und ziehen.

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

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

Was bedeutet REST?

Hier gibt es kein Nickerchen oder Schnarchen, aber 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 leichtgewichtige Kommunikationsmethode bieten, die Bandbreite spart. Die WordPress JSON REST API tut genau dies, was sie zu einer großartigen Option macht, wenn ein hohes Datenvolumen vorhanden ist.

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

JSON-Format

Um auf Daten zuzugreifen, benötigen wir eine Quelle, aus der wir ziehen 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 einfach zu lesen und zu verstehen. Es ist die perfekte Möglichkeit, Informationen organisiert und leicht zugänglich zu speichern. Da JSON so einfach zugänglich ist, eignet es sich hervorragend zum Erstellen 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:

{"employees":[
	{"firstName":"Jane", "lastName":"Smith"},
	{"firstName":"Anna", "lastName":"Olsen"},
	{"firstName":"Josh", "lastName":"Jones"}
]}

JSON-Format in WordPress

JSON schreibt sich nicht einfach selbst, aber keine Sorge, Sie müssen die JSON-Datei nicht manuell erstellen. Es gibt ein großartiges Plugin, das es für Sie erstellt. Mit diesem Tool haben die Daten der Website das richtige Format, einschließlich Benutzer, Beiträge, Seiten, Taxonomien und mehr. Das Plugin finden Sie hier. Außerdem gibt es einige hilfreiche Dokumentationen, die für den Anfang wertvoll sein werden.

WordPress-API

Verwenden 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 das Plugin installiert haben, können Sie damit herumspielen, 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 Request/Response-Protokoll. Zuerst senden Sie eine Datenanforderung und dann werden die Daten als Antwort zurückgesendet.

GET-Methode

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

POST-Anfrage

Eine POST-Anforderung wird verwendet, um Daten zu senden. Mit den Möglichkeiten der neuen API könnten Sie beispielsweise einen Benutzer aktualisieren. Angenommen, 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, empfehle ich 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 enthält eine einfach zu verwendende Javascript-API, die auf Backbone-Modellen basiert. Dies ermöglicht Plugin- und Theme-Entwicklern, ohne großen Aufwand und Wissen über die Details der Verbindung loszulegen. Es gibt noch viel mehr, aber Backbone gibt Webanwendungen Struktur, indem es Modelle, Sammlungen und Ansichten bereitstellt und alles über eine REST-JSON-Schnittstelle mit der WordPress-API verbindet.

WordPress-API-Backbone

Was bedeutet das alles für WordPress-Entwickler?

Mit der Verfügbarkeit der WordPress-API haben neue Nutzungsmöglichkeiten zugenommen und werden dies auch weiterhin tun, wenn sie an Popularität gewinnt. Die WordPress-API kann so gut wie jede vorhandene WordPress-Funktionalität verbessern, die auf Javascript angewiesen ist. Hier sind ein paar Beispiele:

  • Formularvalidierung/-übermittlung
  • Backbone.js-Designs oder -Plugins
  • unendliches Scrollen

Es ist auch eine großartige Möglichkeit, Inhalte aus anderen Quellen anzuzeigen. Jetzt ist es einfach, Inhalte von einer einzelnen Site innerhalb eines Multisite-Setups anzuzeigen. Es ist auch möglich, Inhalte von einer völlig separaten WordPress-Site anzuzeigen. Zusätzlich zum Anzeigen von Inhalten kann der Inhalt auch aktualisiert werden.

Nachdem wir nun einige der grundlegenden Terminologien besprochen haben, wissen wir, dass JSON die Notation ist, REST der Architekturstil und API die Schnittstelle, aus der sie bestehen. Die Kenntnis der Grundlagen der API und ihrer Fähigkeiten stellt sicher, dass Sie einen guten Start haben, wenn Sie die neuen Möglichkeiten mit der WordPress-API erkunden.