Namespaces & Versionen

Dieser Text wurde mithilfe von KI übersetzt. Wenn du den Originaltext auf Englisch lesen möchtest, klicke hier.

Die WordPress.com REST API ist in drei verschiedene Namespaces unterteilt, die jeweils spezifische Zwecke erfüllen und unabhängigen Versionierungsschemata folgen. Das Verständnis dieser Namespaces ist entscheidend, um die richtigen Endpunkte für deine Integration auszuwählen und die Kompatibilität sowohl mit WordPress.com als auch mit selbst gehosteten WordPress-Websites sicherzustellen.

Übersicht der API-Namespaces

Die WordPress.com REST API stellt drei Haupt-Namespaces bereit, die jeweils auf unterschiedliche Anwendungsfälle und Kompatibilitätsstufen ausgerichtet sind:

Namespace	Verfügbare Versionen	Hauptzweck	WordPress-Core-kompatibel
/rest/	v1, v1.1, v1.2, v1.3, v1.4	Legacy-WordPress.com-Verwaltung und Plattformfunktionen	Nein
/wp/	v2	Standard-WordPress-Core-Ressourcen gemäß der offiziellen REST-API-Spezifikation	Ja
/wpcom/	v2, v3, v4	Moderne WordPress.com-spezifische Funktionen und Dienste	Nein

/rest/-Namespace – Legacy-WordPress.com-API

Der /rest/-Namespace stellt die ursprüngliche WordPress.com REST API dar, die vor der WordPress-Core-REST-API existierte. Er bietet umfassenden Zugriff auf WordPress.com-Plattformfunktionen und Website-Verwaltungsmöglichkeiten.

Verfügbare Versionen: v1, v1.1, v1.2, v1.3, v1.4 (zugänglich über die Option WP.COM API in der API-Konsole)

Basis-URLs:

• https://public-api.wordpress.com/rest/v1/
• https://public-api.wordpress.com/rest/v1.1/
• https://public-api.wordpress.com/rest/v1.2/
• https://public-api.wordpress.com/rest/v1.3/
• https://public-api.wordpress.com/rest/v1.4/

Wichtige Funktionen:

• Umfassende Website- und Benutzerverwaltung
• WordPress.com-spezifische Funktionen wie Statistiken, Reader und Benachrichtigungen
• Erweiterte Website-Konfiguration und Domain-Verwaltung
• Jetpack-Integrationsmöglichkeiten

Versionierungsstrategie: Jede Version (v1.1–v1.4) führte schrittweise Verbesserungen, neue Endpunkte und erweiterte Funktionalität ein und wahrte dabei die Abwärtskompatibilität. Wenn Endpunkte über mehrere Versionen hinweg existieren, bieten neuere Versionen in der Regel zusätzliche Felder, verbesserte Leistung oder Fehlerbehebungen.

Am besten geeignet für:

• Zugriff auf WordPress.com-spezifische Funktionen, die anderswo nicht verfügbar sind
• Erweiterte Website-Verwaltung und -Konfiguration
• Aufrechterhaltung der Kompatibilität mit bestehenden Integrationen
• Funktionen wie detaillierte Statistiken, Reader-Funktionalität und Domain-Verwaltung

Beispiel-Endpunkte:

• /rest/v1.4/sites/{site}/posts
• /rest/v1.4/sites/{site}/stats
• /rest/v1.4/me/sites
• /rest/v1.3/read/following

/wp/-Namespace – WordPress Core REST API

Der /wp/-Namespace implementiert die offizielle WordPress REST API-Spezifikation und gewährleistet volle Kompatibilität sowohl mit WordPress.com als auch mit selbst gehosteten WordPress-Websites. Dieser Namespace folgt den vom WordPress-Core-Team festgelegten Standards.

Verfügbare Version: v2 (erreichbar über die Option WP REST API in der API-Konsole)

Basis-URL: https://public-api.wordpress.com/wp/v2/

Hauptmerkmale:

• Standard-WordPress-Ressourcen (Beiträge, Seiten, Kommentare, Taxonomien, Benutzer, Medien)
• Vollständige Kompatibilität mit selbst gehosteten WordPress-Websites
• Einheitliche Endpunkt-Struktur gemäß WordPress-Core-Standards
• Erweiterbar durch Plugins auf selbst gehosteten Websites

Designphilosophie: Dieser Namespace priorisiert Standardisierung und Kompatibilität gegenüber WordPress.com-spezifischen Funktionen. Er spiegelt die REST API wider, die auf jeder WordPress-Installation verfügbar ist, und eignet sich daher ideal für Anwendungen, die in verschiedenen WordPress-Umgebungen funktionieren müssen.

Am besten geeignet für:

• Neue Projekte, die WordPress-Core-Funktionalität erfordern
• Anwendungen, die sowohl mit WordPress.com als auch mit selbst gehosteten Websites funktionieren müssen
• Standard-Content-Management (Beiträge, Seiten, Medien, Benutzer)
• Integrationen mit bestehenden WordPress-Tools und -Plugins

Beispiel-Endpunkte:

• /wp/v2/posts
• /wp/v2/pages
• /wp/v2/users
• /wp/v2/media
• /wp/v2/sites/{site}/posts

/wpcom/-Namespace – Moderne WordPress.com-Plattform-API

Der /wpcom/-Namespace repräsentiert die Weiterentwicklung der WordPress.com-spezifischen API-Funktionalität und bietet modernes Design, moderne Muster und erweiterte Plattformfunktionen, die im WordPress-Core nicht verfügbar sind.

Verfügbare Versionen: v2, v3, v4 (zugänglich über die Option WP REST API in der API-Konsole)

Basis-URLs:

• https://public-api.wordpress.com/wpcom/v2/
• https://public-api.wordpress.com/wpcom/v3/
• https://public-api.wordpress.com/wpcom/v4/

Wichtige Funktionen:

• Modernes API-Design mit verbesserter Struktur und Performance
• Erweiterte WordPress.com-Dienste (Reader, erweiterte Statistiken, Benachrichtigungen)
• Funktionen zur Nutzerinteraktion (Folgen, Likes, Empfehlungen)
• Plattformspezifische Funktionalität, die bei selbst gehostetem WordPress nicht verfügbar ist

Versionierungsstrategie: Jede Version führt neue Funktionen, Sicherheitsverbesserungen und verfeinerte Datenstrukturen ein. Im Gegensatz zum /rest/-Namespace konzentriert sich /wpcom/ auf zukunftsorientierte Funktionalität statt auf Legacy-Kompatibilität.

Am besten geeignet für:

• Moderne WordPress.com-Plattformfunktionen
• Nutzerinteraktion und soziale Funktionen
• Erweiterte Analysen und Empfehlungen
• Neue Integrationen, die die neuesten WordPress.com-Funktionen erfordern

Beispiel-Endpunkte:

• /wpcom/v4/me/follows
• /wpcom/v3/notifications
• /wpcom/v2/read/tags
• /wpcom/v4/sites/{site}/stats/insights

Den richtigen Namespace wählen

Die Wahl des Namespace hängt von deinen spezifischen Anforderungen und Kompatibilitätsbedürfnissen ab:

Verwende /wp/v2/, wenn du Standard-WordPress-Funktionalität benötigst, wie:

• WordPress-Kernfunktionen (Beiträge, Seiten, Benutzer, Medien)
• Kompatibilität mit selbst gehosteten WordPress-Websites
• Standard-REST-API-Muster und -Strukturen
• Integration mit bestehenden WordPress-Tools und -Plugins

Verwende /wpcom/v4/ (oder die neueste verfügbare Version), wenn du WordPress.com-Plattformfunktionen benötigst, wie:

• Erweiterte WordPress.com-Dienste und soziale Funktionen
• Modernes API-Design und verbesserte Performance
• Neueste Plattformfähigkeiten und Integrationen
• Funktionen, die einzigartig für das WordPress.com-Ökosystem sind

Verwende /rest/v1.4/ (oder die erforderliche Version), wenn du Legacy-Funktionen und Kompatibilität benötigst, wie:

• Bestimmte Funktionalität, die nur in Legacy-Endpunkten verfügbar ist
• Abwärtskompatibilität mit bestehenden Integrationen
• Erweiterte Website-Verwaltungsfunktionen, die noch nicht in neuere Namespaces migriert wurden
• Umfassende Statistik- und Analysefunktionen

Richtlinien zur Versionsauswahl

Innerhalb jedes Namespace folgt die Versionsauswahl diesen Prinzipien:

Mehrere Versionen verfügbar: Wenn Endpunkte in mehreren Versionen existieren, bieten neuere Versionen in der Regel:

• Zusätzliche Antwortfelder und Parameter
• Verbesserte Performance und Zuverlässigkeit
• Fehlerbehebungen und Sicherheitsverbesserungen
• Erweiterte Funktionalität bei gleichzeitiger Abwärtskompatibilität

Empfohlener Ansatz: Verwende immer die neueste verfügbare Version, es sei denn:

• Deine Integration hängt von einem bestimmten Verhalten in älteren Versionen ab
• Du pflegst Legacy-Code, der bestimmte API-Antworten erfordert
• Kompatibilitätsanforderungen eine bestimmte Version vorschreiben

Die Organisation der API-Konsole verstehen

Die WordPress.com-API-Konsole organisiert Namespaces in zwei Hauptkategorien:

• WP.COM API: Enthält alle Namespace-Versionen von /rest/ (v1–v1.4)
• WP REST API: Enthält /wp/v2/ und alle Namespace-Versionen von /wpcom/ (v2–v4)

Diese Organisation spiegelt die Entwicklung von WordPress.com-spezifischen APIs hin zu standardisierten WordPress-Core-APIs und modernen Plattformfunktionen wider.

Überlegungen zur Migration

Bei der Planung von Integrationen oder der Aktualisierung bestehender Integrationen:

Neue Projekte: Beginne mit /wp/v2/ für Kernfunktionalität und /wpcom/v4/ für plattformspezifische Funktionen.

Bestehende Integrationen: Erwäge eine Migration von /rest/-Endpunkten zu neueren Namespaces, wenn:

• Gleichwertige Funktionalität in /wp/v2/ oder /wpcom/ vorhanden ist
• Du verbesserte Performance oder zusätzliche Funktionen benötigst
• Langfristige Wartung und Support Priorität haben

Funktionsverfügbarkeit: Einige erweiterte Funktionen sind weiterhin ausschließlich im /rest/-Namespace verfügbar. Prüfe die Funktionsanforderungen vor der Migration, um sicherzustellen, dass alle benötigten Funktionen in den Ziel-Namespaces verfügbar sind.