Inhaltsverzeichnis
- 1. preview.contentful.com (Content Preview API)
- 2. api.contentful.com (Management API)
- Daten abrufen
- Daten anpassen
- 3. cdn.contentful.com (Content Delivery API)
- 4. graphql.contentful.com (GraphQL Content Delivery API)
- 5. images.ctfassets.net (Image API)
- 6. upload.contentful.com (Upload API)
- Schlussfolgerung:
- Cloudapp-dev und bevor Sie uns verlassen
Contentful ist ein großartiges Headless CMS, das sich leicht in neue oder bestehende Next.js 14-Projekte integrieren lässt. Ich verwende es häufig in meinen Webprojekten. Es gibt jedoch mehrere Möglichkeiten, Inhalte zu verwalten (Erstellen, Aktualisieren, Löschen und Bereitstellen von Inhalten). Lassen Sie uns einen tiefen Einblick in die REST-Fähigkeiten dieses CMS nehmen. Nachfolgend finden Sie eine Liste aller verfügbaren Endpunkte sowie einige Beispiele.
1. preview.contentful.com (Content Preview API)
Zweck Dies ist der Vorschau-API-Endpunkt für den Zugriff auf unveröffentlichte (Entwurfs-)Inhalte in Contentful. Er ist nützlich, um Änderungen an Inhalten zu sehen, bevor sie live gehen.
Verwendung Wird typischerweise in Entwicklungsumgebungen oder für die Vorschau von Inhalten in Content-Management-Systemen (CMS) verwendet.
Zugang Erfordert einen Vorschau-API-Schlüssel.
Beispiel für einen Anwendungsfall Ein Inhaltsredakteur möchte eine Vorschau der Änderungen an einem Blogbeitrag anzeigen, bevor er veröffentlicht wird.
Nehmen wir an, Sie haben einen Contentful-Space mit der ID „xxxyyy“ und arbeiten in der „Master“-Umgebung, und Sie haben einen Content-Datensatz mit der ID „3xwgduhyZmdUYieeiW5Pq2“, dann würde Ihre URL lauten:
https://preview.contentful.com/spaces/xxxyyy/environments/master/entries/3xwgduhyZmdUYieeiW5Pq2
Further information regarding the right use of Contentful Environments.
Sie können das Content Preview Token aus dem Contentful Backend erhalten, indem Sie oben rechts auf „Einstellungen“ und dann auf „API-Schlüssel“ klicken. Erstellen Sie einen neuen API-Schlüssel oder öffnen Sie den vorhandenen in der Benutzeroberfläche und scrollen Sie nach unten, bis Sie ihn sehen. Erstellen Sie nun eine GET-Anfrage in Postman und verwenden Sie die richtige URL. Legen Sie in der Registerkarte „Autorisierung“ das Vorschautoken als Träger-Token fest und klicken Sie auf „Senden“, um die „Vorschauversion“ Ihres Inhaltsdatensatzes zu erhalten.
Wie Sie im JSON sehen können, ist der Typ des Inhaltseintrags „PageBlogPost“. Nachfolgend die verschiedenen Felder, die im Contenttype verwendet werden.
2. api.contentful.com (Management API)
Zweck Dies ist der Endpunkt der Content Management API, der für die Verwaltung von Inhalten und anderen Ressourcen in einem Contentful-Bereich verwendet wird. Er bietet CRUD-Operationen (Erstellen, Lesen, Aktualisieren, Löschen) für Einträge, Assets, Inhaltstypen, Umgebungen usw.
Verwendung Wird von Entwicklern verwendet, um Aufgaben wie die Erstellung von Inhaltstypen, die programmatische Aktualisierung von Einträgen oder die Verwaltung von Umgebungseinstellungen zu automatisieren.
Zugang Erfordert einen Content Management API-Schlüssel.
Beispiel für einen Anwendungsfall Ein Entwickler schreibt ein Skript, um Inhalte von einer Umgebung in eine andere zu migrieren.
Erstellen wir einen neuen Inhaltsdatensatz vom Typ „pageBlogPost“. Die URL könnte lauten:
https://api.contentful.com/spaces/xxxyyy/environments/master/entries
Holen Sie sich das CMA-Token aus dem Abschnitt „CMA-Token“ unter Einstellungen in Ihrem Contentful-Konto und verwenden Sie es erneut als Bearer-Token in Ihrer Postman-POST-Anfrage. Fügen Sie die Header „X-Contentful-Content-Type“ -> pageBlogPost (oder jeden von Ihnen erstellten Inhaltstyp) und „Content-Type“ -> application/vnd.contentful.management.v1+json hinzu.
Wählen Sie „raw“ für die Registerkarte „body“ und verwenden Sie dieses Beispiel JSON.
Wie Sie sehen können, verwende ich zwei Sprachen: Deutsch (DE) und Englisch (EN). Wenn die Erstellung erfolgreich war, erhalten Sie eine Meldung „201 Created“ und Sie können Ihren Datensatz im Contentful Backend sehen.
Daten abrufen
können Sie die zuvor erstellten JSON-Daten des Inhaltsdatensatzes abrufen.
Daten anpassen
Lassen Sie uns eine PUT-Anfrage vorbereiten ->
https://api.contentful.com/spaces/xxxyyy/environments/master/entries/3xwgduhyZmdUYieeiW5Pq2
und den Header „X-Contentful-Version“, um die Version für die Änderung anzugeben. Sie können die Version aus dem JSON der vorherigen GET-Anfrage ablesen („publishedVersion“: 3, „publishedAt“: „2024-09-09T15:21:08.978Z“,)
3. cdn.contentful.com (Content Delivery API)
Zweck Dies ist der Endpunkt der Content Delivery API (CDA), der für die Bereitstellung veröffentlichter Inhalte verwendet wird. Er wird von einem Content Delivery Network (CDN) unterstützt, das einen effizienten und schnellen Zugriff auf Inhalte ermöglicht.
Verwendung Wird üblicherweise in Produktionsumgebungen verwendet, um veröffentlichte Inhalte für Websites oder Anwendungen abzurufen.
Zugang Erfordert einen Content Delivery API-Schlüssel.
Beispiel für einen Anwendungsfall Eine Website oder mobile Anwendung ruft Live-Inhalte ab und zeigt sie den Benutzern an.
Holen Sie sich das Content Delivery API - Zugriffstoken aus Ihrem Konto unter Einstellungen / API-Schlüssel
Dieser Aufruf nutzt das schnelle Contentful CDN und liefert Ihnen eine Liste von 10 Content Records (Typ -> pageBlogPost)
4. graphql.contentful.com (GraphQL Content Delivery API)
Zweck Dies ist der GraphQL-Content-Delivery-API-Endpunkt, der Inhalte unter Verwendung der GraphQL-Abfragesprache bereitstellt, die flexiblere und präzisere Abfragen ermöglicht als der REST-basierte CDA.
Verwendung Geeignet für Anwendungen, die eine feinkörnige Kontrolle über die abgerufenen Inhalte benötigen, um ein Über- oder Unterabrufen von Daten zu vermeiden.
Zugang Erfordert einen Content Delivery API-Schlüssel.
Beispiel für einen Anwendungsfall Eine React-basierte Anwendung verwendet GraphQL-Abfragen, um bestimmte Felder von Contentful für das Rendering einer Komponente abzurufen.
Verwenden Sie diesen Endpunkt mit der Content Delivery API - Zugriffstoken
https://graphql.contentful.com/content/v1/spaces/xxxyyy/environments/master
Erstellen Sie eine Postman-POST-Anfrage, autorisieren Sie sich mit dem Bearer Token (CDN-API-Schlüssel) und verwenden Sie diese Graphql-Abfrage auf der Registerkarte Body, indem Sie „GraphQL“ auswählen. Verwenden Sie Ihre Content Record ID.
Antwort JSON (Beispiel)
5. images.ctfassets.net (Image API)
Zweck Dieser Endpunkt wird verwendet, um in Contentful gespeicherte Bilder zu liefern und zu bearbeiten. Er ermöglicht Bildtransformationen wie Größenänderung, Zuschneiden und Formatkonvertierung.
Verwendung Wird in der Produktion verwendet, um optimierte Bilder für verschiedene Geräte oder Bildschirmgrößen zu liefern.
Beispiel für einen Anwendungsfall Eine Website verwendet diesen Endpunkt, um optimierte, reaktionsfähige Bilder für schnellere Ladezeiten abzurufen.
Wie Sie in der vorherigen JSON-Antwort sehen können, verwendet Contentful diesen Endpunkt für die Bereitstellung und Bearbeitung von Bildern.
6. upload.contentful.com (Upload API)
Zweck Dies ist der Endpunkt der Upload-API, der zum Hochladen großer Dateien (Assets) in Contentful verwendet wird. Im Gegensatz zur Content Management API, die alle Arten von Ressourcen handhabt, ist die Upload API speziell für den Upload von großen Assets optimiert.
Verwendung Wird häufig in Automatisierungsskripten oder benutzerdefinierten Anwendungen verwendet, bei denen große Dateien programmatisch hochgeladen werden müssen.
Zugang: Erfordert einen Content Management API-Schlüssel.
Beispiel für einen Anwendungsfall Eine Anwendung lädt massenhaft Bilder oder Videos hoch, die in Contentful verwaltet und veröffentlicht werden sollen.
Schlussfolgerung:
preview.contentful.com Dient der Vorschau von unveröffentlichten Inhalten. api.contentful.com Dient zur Verwaltung von Inhalten und Konfigurationen. cdn.contentful.com Für die schnelle Bereitstellung von veröffentlichten Inhalten. graphql.contentful.com Für die Bereitstellung von veröffentlichten Inhalten mit flexiblen GraphQL-Abfragen. images.ctfassets.net Für die Auslieferung und Umwandlung von Bildern. upload.contentful.com Für das Hochladen großer Dateien als Assets.
Jeder Endpunkt hat einen bestimmten Zweck und ist für verschiedene Szenarien im Content-Management- und Bereitstellungs-Workflow optimiert.
Cloudapp-dev und bevor Sie uns verlassen
Danke, dass Sie bis zum Ende gelesen haben. Noch eine Bitte bevor Sie gehen:
