REST API — Benutzerdefinierte Felder für Headless-Apps bereitstellen | Field Forge - Benutzerdefinierte Felder, gebaut für Geschwindigkeit
Herunterladen Anmelden

REST API — Benutzerdefinierte Felder für Headless-Apps bereitstellen

Zwei Möglichkeiten, auf benutzerdefinierte Felder zuzugreifen

1. Inline an den Kern-REST-Endpunkten

Wenn Field Forge aktiv ist, enthält jede wp/v2/posts, wp/v2/pages und wp/v2/{custom_post_type} Antwort eine fieldforge Eigenschaft, die die Werte der benutzerdefinierten Felder enthält:

“`json GET /wp-json/wp/v2/posts/123

{ “id”: 123, “title”: { “rendered”: “Über uns” }, “content”: { “rendered”: “…” }, “fieldforge”: { “hero_title”: “Willkommen auf unserer Seite”, “hero_subtitle”: “Bessere WordPress-Erlebnisse schaffen”, “hero_image”: { “id”: 456, “url”: “https://example.com/hero.jpg”, “alt”: “Heldenbild”, “sizes”: { “thumbnail”: “https://…”, “medium”: “https://…”, “large”: “https://…” } }, “team_members”: [ { “name”: “Alice Johnson”, “photo”: { “id”: 234, “url”: “…”, “alt”: “Alice” }, “bio”: “Alice ist…” }, { “name”: “Bob Smith”, “photo”: { “id”: 235, “url”: “…”, “alt”: “Bob” }, “bio”: “Bob ist…” } ] } } “`

So konsumieren die meisten Headless-WordPress-Seiten benutzerdefinierte Felder — einen Beitrag abrufen, benutzerdefinierte Felder in derselben Antwort erhalten, keine zusätzlichen Anfragen erforderlich.

2. Dedizierte Field Forge-Endpunkte

Für fortgeschrittene Anwendungsfälle stellt Field Forge seine eigene REST API unter /wp-json/fieldforge/v1/ bereit.


Endpunkt-Referenz

Feldgruppen

GET /wp-json/fieldforge/v1/field-groups GET /wp-json/fieldforge/v1/field-groups/{id} POST /wp-json/fieldforge/v1/field-groups PUT /wp-json/fieldforge/v1/field-groups/{id} DELETE /wp-json/fieldforge/v1/field-groups/{id}

Feldgruppen auflisten, lesen, erstellen, aktualisieren und löschen. Anwendungsfälle: Headless-Admin-Panels, programmgesteuerte Feldgruppeneinrichtung, CI/CD-Schema-Bereitstellung.

Feldwerte

GET /wp-json/fieldforge/v1/fields/{post_id} PUT /wp-json/fieldforge/v1/fields/{post_id}

Alle Feldwerte für einen bestimmten Beitrag abrufen oder aktualisieren. Die GET Antwort entspricht dem Format, das in der fieldforge Eigenschaft der Kern-REST-API zurückgegeben wird.

Beispiel: “ GET /wp-json/fieldforge/v1/fields/123

json { "post_id": 123, "field_group": "hero-section", "values": { "hero_title": "Willkommen", "hero_image": { "id": 456, "url": "..." } } }

Optionsseiten

GET /wp-json/fieldforge/v1/options/{page_slug} PUT /wp-json/fieldforge/v1/options/{page_slug}

Werte von Optionsseiten lesen und aktualisieren. Perfekt für Headless-Seiten, die siteweite Einstellungen benötigen (Firmenname, soziale URLs, globale CTAs).

Schema-Metadaten

GET /wp-json/fieldforge/v1/schema GET /wp-json/fieldforge/v1/schema/typescript GET /wp-json/fieldforge/v1/schema/graphql

Das vollständige Field Forge-Schema als JSON, als TypeScript-Definitionen oder als GraphQL SDL abrufen. In Frontend-Bau-Pipelines verwenden, um Typen automatisch synchron zu halten.

Migration und Import

POST /wp-json/fieldforge/v1/import/acf POST /wp-json/fieldforge/v1/import/meta-box POST /wp-json/fieldforge/v1/import/cmb2

Importe von Quell-Plugins über die API auslösen. Nützlich für CI/CD-Einrichtungs-Skripte.

AI-Generierung

POST /wp-json/fieldforge/v1/generate

Body: “json { "description": "Hero-Bereich mit Titel, Untertitel, Hintergrundbild und CTA-Button" }

Gibt eine generierte Feldgruppe zurück, die bereit zum Speichern ist. In benutzerdefinierten Admin-Tools oder Automatisierungs-Workflows verwenden.


Authentifizierung

Die REST API von Field Forge verwendet die nativen Authentifizierungsmechanismen von WordPress:

Cookie-Authentifizierung (angemeldete Benutzer)

Wenn die Anfrage von einem angemeldeten WordPress-Benutzer kommt (z. B. Ihr Admin-Panel, das AJAX-Aufrufe tätigt), authentifizieren die Cookies des Benutzers die Anfrage automatisch.

Anwendungs-Passwörter (Headless-Frontends)

WordPress 5.6+ unterstützt Anwendungs-Passwörter — API-Anmeldeinformationen pro Benutzer, die im WordPress-Admin unter Benutzer → Bearbeiten → Anwendungs-Passwörter generiert werden können. Verwenden Sie diese für die Authentifizierung von Headless-Frontends:

bash curl -u benutzername:anwendungs_passwort https://wp.example.com/wp-json/fieldforge/v1/field-groups

JWT-Authentifizierung (Drittanbieter-Plugin)

Wenn Sie ein JWT-Auth-Plugin (wie „JWT Authentication for WP REST API“) verwenden, akzeptieren die Endpunkte von Field Forge JWT-Token automatisch.

OAuth 2.0

Für den Unternehmenseinsatz sind die Endpunkte von Field Forge mit WordPress OAuth 2.0-Server-Plugins kompatibel.


Fähigkeitsprüfungen

REST-Endpunkte respektieren die WordPress-Fähigkeiten:

  • Lesebetriebe (GET): erfordern die read Fähigkeit (typischerweise jeder angemeldete Benutzer)
  • Schreiboperationen (POST, PUT, DELETE) auf Feldern: erfordern die edit_post Fähigkeit für den Zielbeitrag
  • CRUD für Feldgruppen: erfordern die manage_options Fähigkeit (nur Administratoren)
  • Import/Migration: erfordern die manage_options Fähigkeit

Sie können diese mit den Standard-WordPress-Fähigkeits-Hooks filtern, wenn Sie andere Berechtigungsmodelle benötigen.


Pro-Feldwerte auf der WP REST API

Field Forge stellt Feldwerte an den Kern-WordPress-REST-Endpunkten als fieldforge Eigenschaft bereit. Dies ist der empfohlene Ansatz für Headless-Frontends, weil:

  • Eine Anfrage ruft Beitragsdaten + benutzerdefinierte Felder ab (kein N+1-Problem)
  • Standard-REST-API-Format — keine Lernkurve
  • Funktioniert mit WordPress REST API-Clients (wp-rest-api-Client-Bibliotheken in JS, PHP, Python usw.)
  • Kompatibel mit statischen Site-Generatoren (Next.js getStaticProps, Astro getStaticPaths, usw.)

Für die meisten Headless-Seiten ist die fieldforge Eigenschaft an den Kern-REST-Endpunkten alles, was Sie benötigen. Dedizierte Field Forge-Endpunkte sind für fortgeschrittene Anwendungsfälle.


Leistung der REST API

REST API-Antworten profitieren von Field Forges benutzerdefinierter Tabellenspeicherung und Batch-Ladung. Eine einzelne REST-Abfrage, die einen Beitrag + benutzerdefinierte Felder abruft, läuft in 1–2 SQL-Abfragen anstelle von 20+.

Für Listenendpunkte (/wp/v2/posts?per_page=20) bündelt Field Forges Auto-Preloader benutzerdefinierte Feldabfragen über alle 20 Beiträge in eine einzige Abfrage, wodurch die Antwortzeiten auch für inhaltsreiche Listenansichten schnell bleiben.


Kombination mit GraphQL

Field Forge unterstützt sowohl die REST API als auch die WPGraphQL-Integration. Verwenden Sie, was am besten zu Ihrem Frontend passt:

  • REST API — einfacher, funktioniert mit jedem HTTP-Client
  • GraphQL — effizienter für tief verschachtelte Abfragen, bessere Typensicherheit in Kombination mit dem GraphQL-Code-Generator

Beide APIs stellen dieselben zugrunde liegenden Field Forge-Daten bereit.


Bereit, mit WordPress benutzerdefinierten Feldern headless zu gehen?

Holen Sie sich Field Forge — ab $35/Jahr →

Die REST API ist in jedem kostenpflichtigen Plan enthalten. Feldwerte an den Kern-REST-Endpunkten sind auch in der kostenlosen Version verfügbar.

Forge KI-Assistent Online

Hallo! Ich bin der Field Forge KI-Assistent. Fragen Sie mich alles über das Plugin — Einrichtung, Funktionen, Fehlerbehebung oder Entwicklung.

Gerade eben
Unterstützt von Forge KI · Dokumentation durchsuchen