Wordpress API: Der vollständige Entwickler-Leitfaden

Wenn Sie Webanwendungen, mobile Apps oder Frontend-Clients entwickeln, die programmatisch mit einer WordPress-Website interagieren müssen, ist die WordPress API Ihr Schlüsselwerkzeug. Mit einer ordnungsgemäß konfigurierten Website und den von WordPress (oder WordPress.com) bereitgestellten REST-Endpunkten können Sie Beiträge abrufen, neue Inhalte erstellen, bestehende Seiten bearbeiten, Benutzer, Kommentare und vieles mehr verwalten – alles über Standard-HTTP-Anfragen. Dieser Leitfaden führt Sie durch die ersten Schritte mit der WordPress API, erklärt die URL-Struktur, wie CRUD-Operationen durchgeführt werden und wie Sie alles in einem Browser oder mit einem API-Tool wie Apidog testen können.

Erste Schritte mit der WordPress API

a) Konto- oder Website-Einrichtung

• Wenn Sie eine selbst gehostete WordPress-Website (WordPress.org) verwenden, stellen Sie sicher, dass Ihre Website installiert und läuft.

• Wenn Sie mit einer WordPress.com-Website arbeiten, melden Sie sich bei WordPress.com an und suchen Sie Ihr Website-Dashboard.

• Stellen Sie sicher, dass der REST-API-Zugriff aktiviert ist – standardmäßig stellen moderne WordPress-Installationen die WP REST API unter your-site-url/wp-json/ zur Verfügung.

Es ist keine zusätzliche Kontoerstellung erforderlich, außer dem Zugriff auf die Website (und entsprechenden Berechtigungen) – die REST API ist im WordPress-Kern integriert und standardmäßig zugänglich.

b) Verständnis der Basis-URL-Struktur

Für eine selbst gehostete WordPress-Website ist die Basis-API-URL:

https://your-site.com/wp-json/

Um beispielsweise Beiträge abzurufen, würden Sie Folgendes ansteuern:

https://your-site.com/wp-json/wp/v2/posts

Wenn "sprechende Permalinks" deaktiviert sind, kann WordPress die API immer noch über einen Query-Parameter-Fallback bereitstellen – aber in den meisten modernen Setups funktioniert /wp-json/ sofort.

Für WordPress.com-gehostete Websites (oder Websites, die die WordPress.com REST API verwenden) kann die URL-Struktur leicht abweichen, abhängig vom Namespace und dem Website-Identifikator. Zum Beispiel:

https://public-api.wordpress.com/{namespace}/{version}/sites/{site_id}/...

Schauen Sie sich die offiziellen Dokumente unter WordPress Developer Resources an, um einen detaillierteren Leitfaden zur Basis-URL-Struktur zu erhalten.

Verwendung der WordPress REST API: CRUD-Operationen

Die WordPress API unterstützt alle Standard-CRUD-Operationen – Erstellen, Lesen, Aktualisieren, Löschen – unter Verwendung der entsprechenden HTTP-Methode (POST, GET, PUT, DELETE). Lassen Sie uns diese anhand konkreter Beispiele aufschlüsseln, die Sie im Browser oder mit Apidog testen können.

1. Lesen: Beiträge oder Seiten abrufen

• Um eine Liste von Beiträgen zu erhalten:

GET https://your-site.com/wp-json/wp/v2/posts

• Um einen einzelnen Beitrag anhand der ID abzurufen:

GET https://your-site.com/wp-json/wp/v2/posts/{id}

• Sie können Abfrageparameter hinzufügen, um Ergebnisse zu filtern oder zu paginieren – zum Beispiel:

GET https://your-site.com/wp-json/wp/v2/posts?per_page=5&page=2

GET https://your-site.com/wp-json/wp/v2/posts?status=draft

Sie können auch steuern, welche Felder zurückgegeben werden, indem Sie den Abfrageparameter _fields verwenden (z. B. ? _fields=id,title,excerpt,link), um die Größe der Nutzlast zu reduzieren und die Leistung zu verbessern.

Dasselbe gilt für Seiten (über /wp-json/wp/v2/pages) oder andere Ressourcentypen wie Medien, Kommentare usw., je nachdem, was Ihre Website bereitstellt.

2. Erstellen: Einen neuen Beitrag hinzufügen

Wenn Sie authentifiziert sind (als Administrator oder Benutzer mit Berechtigungen), können Sie einen neuen Beitrag erstellen über:

POST https://your-site.com/wp-json/wp/v2/posts

Mit einem JSON-Body, zum Beispiel:

{
  "title": "Mein neuer API-Beitrag",
  "content": "Dieser Beitrag wurde über die WordPress API erstellt.",
  "status": "publish"
}

Diese Anfrage erstellt einen neuen Beitrag. Optional können Sie den Status auf "draft" oder andere gültige Status setzen, wenn Sie nicht sofort veröffentlichen möchten.

3. Aktualisieren: Einen bestehenden Beitrag bearbeiten

Um einen Beitrag anhand der ID zu aktualisieren (z. B. den Titel oder den Inhalt zu aktualisieren):

PUT https://your-site.com/wp-json/wp/v2/posts/{id}

Beispiel-Body:

{
  "title": "Aktualisierter Titel über API",
  "content": "Aktualisierter Inhalt von der API."
}

Alternativ akzeptieren einige Implementierungen PATCH. Nach einer erfolgreichen Anfrage antwortet die API mit dem aktualisierten Beitragsobjekt.

4. Löschen: Einen Beitrag entfernen

Um einen Beitrag anhand der ID zu löschen:

DELETE https://your-site.com/wp-json/wp/v2/posts/{id}

Standardmäßig verschiebt dies den Beitrag in der Regel in den Papierkorb (wenn der Papierkorb aktiviert ist). Sie können Parameter hinzufügen (abhängig von der Website-Konfiguration), um ihn dauerhaft zu löschen, falls dies unterstützt wird.

Authentifizierungs- & Sicherheitsüberlegungen bei der Verwendung der WordPress API

• Öffentliche Daten (z.B. veröffentlichte Beiträge) können oft ohne Authentifizierung abgerufen werden.
• Zum Erstellen, Aktualisieren oder Löschen von Inhalten benötigen Sie in der Regel eine Authentifizierung – über WordPress-Login-Cookies, Anwendungspasswörter (verfügbar seit WP 5.6) oder OAuth / Token-basierte Systeme.
• Verwenden Sie in der Produktion immer HTTPS, um Anmeldeinformationen und Daten während der Übertragung zu schützen.

Testen von WordPress API-Endpunkten (Browser oder Apidog)

Sie können Endpunkte genauso einfach mit einem Browser oder einem API-Testtool wie Apidog testen.

Browser verwenden:

• Fügen Sie die URL (z. B. .../wp-json/wp/v2/posts) in die Adressleiste des Browsers ein.
• Der Browser zeigt rohes JSON an – um es lesbar zu machen, installieren Sie eine JSON-Formatter-Erweiterung (z. B. JSON Formatter für Chrome, Firefox).

Apidog verwenden:

• Erstellen Sie einen neuen API-Endpunkt in Apidog.
• Geben Sie die URL ein (z. B. /wp-json/wp/v2/posts).
• Wählen Sie die HTTP-Methode (GET, POST, PUT, DELETE).
• Fügen Sie bei Bedarf Header hinzu (zur Authentifizierung).

• Senden Sie die Anfrage und überprüfen Sie die JSON-Antwort – Apidog zeigt strukturiertes JSON, Fehler, Antwort-Header an und erleichtert das Debugging im Vergleich zu rohen Browser-Ausgaben.

Diese Methode ist besonders nützlich für POST/PUT/DELETE-Anfragen – wo der Browser allein keine einfache Möglichkeit bietet, JSON-Anfrage-Bodies oder benutzerdefinierte Header zu senden.

Best Practices & Tipps für Entwickler, die die WordPress API verwenden

1. Verwenden Sie _fields oder Paginierungsparameter, um die Nutzlastgröße beim Abrufen großer Datenmengen zu begrenzen.
2. Authentifizieren Sie sich sicher mit Anwendungspasswörtern oder OAuth für Schreiboperationen.
3. Überprüfen Sie die Permalink-Einstellungen der Website – stellen Sie sicher, dass "sprechende Permalinks" oder Fallback-REST-Routen (wp-json/) funktionieren.
4. Berechtigungen verwalten – nur Benutzer mit den entsprechenden Rollen können Inhalte erstellen oder löschen.
5. Rate-Limit und Fehlerbehandlung – behandeln Sie API-Fehler elegant und respektieren Sie Serverressourcen.
6. Verwenden Sie JSON-Formatierungstools beim Testen im Browser für bessere Lesbarkeit oder zum Debugging.

Häufig gestellte Fragen (FAQ)

F1. Benötige ich immer einen API-Schlüssel, um die WordPress API zu verwenden?
Nein – für öffentliche Daten wie veröffentlichte Beiträge oder öffentliche Seiten können Sie GET-Anfragen ohne Authentifizierung verwenden. Für das Erstellen, Bearbeiten oder Löschen von Inhalten benötigen Sie jedoch in der Regel die entsprechenden Anmeldeinformationen. (Für weitere Details zu diesem Thema besuchen Sie WPZOOM)

F2. Was ist der Unterschied zwischen wp-json/wp/v2/ und public-api.wordpress.com Endpunkten?
wp-json/wp/v2/ wird von selbst gehosteten WordPress-Websites (WordPress.org) verwendet. Die Struktur public-api.wordpress.com/... wird von WordPress.com gehosteten Websites verwendet – die Basis-URL und die Namespaces unterscheiden sich, aber das Konzept der REST API bleibt ähnlich. (Weitere Beispiele finden Sie im Noroff FEU Content System)

F3. Kann ich benutzerdefinierte Endpunkte erstellen oder benutzerdefinierte Beitragstypen in der API bereitstellen?
Ja. Standardmäßig werden Kern-Beitragstypen (Beiträge, Seiten, Medien, Kommentare usw.) bereitgestellt. Für benutzerdefinierte Beitragstypen oder benutzerdefinierte Felder (Metadaten) müssen Sie möglicherweise die REST-Unterstützung in Ihrem Theme oder Plugin registrieren (z. B. mit register_post_type(..., 'show_in_rest' => true)).

F4. Wie kann ich API-Endpunkte ohne Code zu schreiben testen?
Sie können einen Browser verwenden (für GET-Anfragen) – navigieren Sie einfach zur Endpunkt-URL. Für POST/PUT/DELETE (oder Operationen, die Authentifizierung erfordern) verwenden Sie ein API-Client-Tool wie Apidog. Es ermöglicht Ihnen, JSON-Bodies zu senden, Header festzulegen und Antworten bequem zu überprüfen.

F5. Ist es sicher, Benutzer- oder Kommentardaten über die API preiszugeben?
Wenn Ihre Website den öffentlichen Zugriff auf bestimmte Ressourcen (wie öffentlich sichtbare Beiträge oder Kommentare) erlaubt, dann ja – die API gibt nur das zurück, was erlaubt ist. Für private Daten oder authentifizierte Operationen stellen Sie sicher, dass die entsprechenden Authentifizierungen und Berechtigungen vorhanden sind.

Fazit

Die WordPress API verwandelt Ihre WordPress-Website in ein programmierbares Backend – sie ermöglicht Ihnen das Lesen, Erstellen, Aktualisieren und Löschen von Inhalten über Standard-HTTP-Aufrufe.

Ob Sie ein Headless-CMS-Frontend, eine mobile App entwickeln oder Content-Workflows automatisieren, die REST API bietet Ihnen eine robuste, flexible Schnittstelle.

Durch das Verständnis der URL-Struktur, der Kern-Endpunkte, der CRUD-Semantik, der Authentifizierung und der Testmethodik (über Browser oder Apidog) können Sie WordPress in praktisch jedes externe System integrieren.

Mit guten API-Praktiken – sicherer Authentifizierung, effizienten Abfragen und ordnungsgemäßer Handhabung – wird WordPress mehr als nur eine Blogging-Plattform – es wird zu einem voll ausgestatteten Content-Backend.