Skip to Content
Entwicklerdokumentation

Öffentliche Content-API aufrufen

Veröffentlichte Inhalte mit API v1, Seitennavigation, Sprachfallback und Headless-Bereitstellung lesen.

Öffentliche Content-API aufrufen

Nutzen Sie die öffentliche API für externe Frontends und Inhaltskonsumenten. Veröffentlichte Einträge benötigen keinen API-Schlüssel. Entwürfe und archivierte Einträge bleiben verborgen; Änderungen werden erst nach Veröffentlichung öffentlich.

Kennungen und Endpunkte wählen

Setzen Sie QOKIT_API_URL auf den API- oder Installationsursprung, QOKIT_PROJECT_SLUG auf den Projekt-Slug und QOKIT_COLLECTION_KEY auf den Sammlungsschlüssel. Diese Routen verwenden Slugs und Schlüssel, Verwaltungsrouten Ressourcen-IDs.

GET /v1/projects/slug/{slug}/cms/collections/{collectionKey}/entries?locale=en&page=1&pageSize=24
GET /v1/projects/slug/{slug}/cms/collections/{collectionKey}/entries/{entrySlug}?locale=en
GET /v1/projects/slug/{slug}/runtime?locale=en

Alle Seiten und einen Eintrag lesen

Laden Sie den Client anhand der Einrichtung in Site- / CMS-API verwenden.

import { createSiteApiClient } from './sdk/client.mjs';

const api = createSiteApiClient({ baseUrl: process.env.QOKIT_API_URL });
const projectSlug = process.env.QOKIT_PROJECT_SLUG;
const collectionKey = process.env.QOKIT_COLLECTION_KEY;
const entries = [];
let page = 1;
let result;
do {
  result = await api.publicEntries(projectSlug, collectionKey, {
    locale: 'en', page, pageSize: 24
  });
  entries.push(...result.entries);
  page++;
} while (page <= result.totalPages);

if (entries.length) {
  const detail = await api.publicEntry(projectSlug, collectionKey, entries[0].slug, {
    locale: result.locale
  });
  console.log(detail.entry.title);
}
console.log(entries.length, result.locale, result.localeFallback);

Antwort auswerten

Listen liefern entries, page, pageSize, total und totalPages, Details liefern entry. Standardgröße: 24, Maximum: 100. Die erste Seite enthält nicht die gesamte Sammlung.

Verwenden Sie das zurückgegebene locale für Eintragslinks. localeFallback enthält requestedLocale, resolvedLocale und usedFallback. Reihenfolge: regionale Sprache, Basissprache, Projektstandard, Englisch. Ein übergeordnetes requestedLocale hängt von der Bereitstellung ab.

Prüfen Sie den Dienstvertrag für search, category, brand, minPrice, maxPrice, featured und sort; ihre Wirkung hängt von der Sammlung ab. Validiertes fieldQuery ist eine Plattform-Erweiterung; unabhängige Installationen weisen es mit 400 zurück.

Bereitstellung, Ursprünge und Kompatibilität

Die öffentliche Plattform-Runtime liest die veröffentlichte Website-Version. CMS-managed und CMS-only bieten aktuelle öffentliche CMS-Daten. Site-only enthält nur statisches HTML und Ressourcen, ohne Inhalts-API. CMS-only besitzt keinen Website-Renderer. Verwaltungsschlüssel gehören nicht in Frontend-Code.

Plattformrouten unter /projects/slug/{slug} bleiben verfügbar. Unabhängige /api/content/collections/{collectionKey}/entries bleiben mit verschachtelten pagination-Metadaten verfügbar. Neue Integrationen verwenden v1 und seinen OpenAPI-Vertrag.

Behandeln Sie 404 für fehlende veröffentlichte Inhalte und 400 für ungültige Filter. Bei 429 Retry-After beachten. Erlaubte Frontend-Ursprünge gemäß Verwaltungsleitfaden konfigurieren.

Für Authentifizierung, CORS, Schreibzugriffe und Bereitstellungsunterschiede siehe Site- / CMS-API verwenden.

War diese Anleitung hilfreich?

Zuletzt aktualisiert

Auf dieser Seite