Skip to Content
Документация для разработчиков

Вызов публичного API контента

Чтение опубликованного контента через API v1 с пагинацией, языковым резервированием и headless-развёртыванием.

Вызов публичного API контента

Используйте публичный API для внешнего frontend или потребителя контента. Опубликованные записи не требуют ключа API. Черновики и архивы скрыты; последующие изменения остаются закрытыми до публикации.

Выбор идентификаторов и endpoints

Укажите в QOKIT_API_URL источник API или установки, в QOKIT_PROJECT_SLUG — slug проекта, в QOKIT_COLLECTION_KEY — ключ коллекции. Эти маршруты используют slug и ключ, управление — ID ресурсов.

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

Чтение всех страниц и записи

Скачайте клиент по инструкции в Использование API сайта / 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);

Обработка ответа

Списки возвращают entries, page, pageSize, total и totalPages; детали — entry. Размер по умолчанию 24, максимум 100. Первая страница не содержит всю коллекцию.

Для ссылок используйте возвращённый locale. localeFallback содержит requestedLocale, resolvedLocale и usedFallback. Порядок: региональный язык, базовый, язык проекта по умолчанию, английский. Верхнеуровневый requestedLocale зависит от развёртывания.

Проверьте контракт для search, category, brand, minPrice, maxPrice, featured и sort; применимость зависит от коллекции. Проверенный fieldQuery — расширение платформы; независимые установки отклоняют его с 400.

Развёртывание, источники и совместимость

Публичный runtime платформы читает опубликованную версию сайта. CMS-managed и CMS-only предоставляют актуальные публичные данные CMS. Site-only содержит только статические HTML-страницы и ресурсы, без API контента. CMS-only не содержит renderer сайта. Не помещайте ключ управления во frontend.

Маршруты платформы /projects/slug/{slug} сохраняются. Независимые /api/content/collections/{collectionKey}/entries сохраняются с вложенными метаданными pagination. Новые интеграции используют v1 и его контракт OpenAPI.

Обрабатывайте 404 при отсутствии опубликованного контента и 400 для неверных фильтров. При 429 соблюдайте Retry-After. Настройте разрешённые frontend-источники согласно руководству по управлению.

Об аутентификации, CORS, записи и различиях развёртывания см. Использование API сайта / CMS.

Было ли это руководство полезным?

Последнее обновление:

На этой странице