WordPress API verwenden

Der Begriff API ist aus unserer modernen Welt nicht mehr wegzudenken. Warum das so ist und für welchen Zweck API’s genutzt werden, möchte ich euch gerne in meinen Artikel näher bringen.

Was ist eine API?

Das Wort API ist die englische Abkürzung für Application Programming Interface und bedeutet ins deutsche übersetzt: Anwendungsprogrammier-Schnittstelle.

Für einen Laien – meiner Meinung nach – noch sehr technisch. Deshalb gehen wir mal mehr ins Detail.

Eine API wird im Grunde immer von einem Softwaresystem angeboten. Die bekanntesten Beispiele sind u.a. Facebook, Google oder Twitter. Aber auch WordPress und meine WordPress Installation selbst, besitzen so eine Schnittstelle.

Diese bereitgestellte API kann dann von einem anderen Softwaresystem konsumiert und für seine eigenen Dienste genutzt werden.

So, was heißt das jetzt im Fall meiner WordPress Installation?

Wenn ich beispielsweise meine URL (weristsam.de) mit folgendem URL-Zusatz paare..
=> Das klappt natürlich auch mit eurer WordPress-Installation 😉

/wp-json/wp/v2/posts

Dann sollten wir folgende Ausgabe im Browser erhalten.

 

Et voilá!

Das Ergebnis liefert alle meine publizierten Beiträge in Form eines JSON Objekt zurück.

Wie ihr sehen könnt, ist die Beispiel Schnittstelle als URL im Browser abrufbar. In diesem Fall auch möglich, da auch keine Authentifizierung stattfindet.

Tipp: Ich persönlich nutze und bevorzuge zum Testen solcher API’s das Programm Postman. (Demnächst entsteht ein neuer Artikel der sich Rund um das Thema Postman, API und Authorization dreht)

 

Wichtig ist bei Postman die Angabe des API Request Parameter, welche du links neben der URL findest.

Die wichtigsten Parameter bilden GET, POST, PUT und DELETE.

Ein kurzer Rund-um-Schlag: Mit GET werden Inhalte geholt. Mit POST, PUT gespeichert und upgedated und bei DELETE, richtig! Wieder gelöscht.

Natürlich bietet WordPress noch andere API’s. Welche das sind und was du damit anstellen kannst, findest du unter folgender REST API Dokumentation.

Wie verwende ich das JSON Objekt auf meiner Webseite?

An dieser Stelle denken sicher viele, man könnte die Artikel auch als Datenbank Query in Kombination mit einer PHP-foreach ausgeben.

Das stimmt! Allerdings nur wenn ein Zugriff auf die Datenbank besteht. Deshalb möchte ich euch das Ganze gerne in einer codepen.io Demo vorstellen.

See the Pen
gVGOmM
by Sam (@weristsam)
on CodePen.

Über den obigen Link zeige ich euch wir ihr das JSON via AJAX als JavaScript Objekt erhaltet und für euere Webseite weiterverwenden könnt.

Bei Fragen gerne Fragen. In diesem Sinne, frohes schaffen!

Eure Sam

 

zurück

Kommentare