Skip to Content
Dokumentacja dla deweloperów

Wywołanie publicznego API treści

Odczyt opublikowanych treści przez API v1 z paginacją, zastępczym językiem i wdrożeniami headless.

Wywołanie publicznego API treści

Używaj publicznego API dla zewnętrznych frontendów i odbiorców treści. Opublikowane wpisy nie wymagają klucza API. Szkice i archiwa są ukryte; późniejsze zmiany pozostają prywatne do publikacji.

Wybór identyfikatorów i endpointów

Ustaw QOKIT_API_URL na origin API lub instalacji, QOKIT_PROJECT_SLUG na slug projektu, a QOKIT_COLLECTION_KEY na klucz kolekcji. Te trasy używają slugów i kluczy, zarządzanie używa ID zasobów.

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

Odczyt wszystkich stron i wpisu

Pobierz klienta zgodnie z instrukcjami w Korzystanie z API witryny / CMS.

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);

Interpretacja odpowiedzi

Listy zwracają entries, page, pageSize, total i totalPages; szczegóły zwracają entry. Domyślnie 24, maksymalnie 100 elementów. Pierwsza strona nie zawiera całej kolekcji.

Dla linków użyj zwróconego locale. localeFallback zawiera requestedLocale, resolvedLocale i usedFallback. Kolejność: język regionalny, bazowy, domyślny projektu, angielski. Pole główne requestedLocale zależy od wdrożenia.

Sprawdź kontrakt dla search, category, brand, minPrice, maxPrice, featured i sort; zastosowanie zależy od kolekcji. Zweryfikowane fieldQuery to rozszerzenie platformy; niezależne instalacje odrzucają je kodem 400.

Wdrożenie, originy i zgodność

Publiczny runtime platformy odczytuje opublikowaną wersję witryny. CMS-managed i CMS-only oferują aktualne publiczne treści CMS. Site-only zawiera tylko statyczne HTML i zasoby, bez API treści. CMS-only nie renderuje witryny. Nie umieszczaj klucza zarządzania w frontendzie.

Trasy platformy /projects/slug/{slug} pozostają dostępne. Niezależne /api/content/collections/{collectionKey}/entries pozostają z zagnieżdżonymi metadanymi pagination. Nowe integracje używają v1 i kontraktu OpenAPI.

Obsłuż 404 dla brakujących opublikowanych treści i 400 dla nieprawidłowych filtrów. Przy 429 stosuj Retry-After. Skonfiguruj dozwolone originy frontendu zgodnie z poradnikiem zarządzania.

Uwierzytelnianie, CORS, zapisy i różnice wdrożenia opisuje Korzystanie z API witryny / CMS.

Czy ten przewodnik był pomocny?

Ostatnia aktualizacja

Na tej stronie