Skip to Content
Dokumentasi pengembang

Memanggil API konten publik

Baca konten terbit dengan API v1, paginasi, fallback bahasa, dan penerapan headless.

Memanggil API konten publik

Gunakan API publik untuk frontend eksternal atau konsumen konten. Entri terbit tidak memerlukan kunci API. Draf dan arsip disembunyikan; perubahan berikutnya tetap privat sampai dipublikasikan.

Memilih pengenal dan endpoint

Atur QOKIT_API_URL ke origin API atau instalasi, QOKIT_PROJECT_SLUG ke slug proyek, dan QOKIT_COLLECTION_KEY ke kunci koleksi. Rute ini menggunakan slug dan kunci; pengelolaan menggunakan ID sumber daya.

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

Membaca semua halaman dan satu entri

Unduh klien mengikuti konfigurasi di Menggunakan API situs / 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);

Memahami respons

Daftar mengembalikan entries, page, pageSize, total, dan totalPages; detail mengembalikan entry. Ukuran standar 24, maksimal 100. Halaman pertama saja tidak memuat seluruh koleksi.

Gunakan locale hasil untuk tautan entri. localeFallback berisi requestedLocale, resolvedLocale, dan usedFallback. Urutannya bahasa regional, bahasa dasar, standar proyek, lalu Inggris. requestedLocale tingkat atas bergantung pada penerapan.

Periksa kontrak untuk search, category, brand, minPrice, maxPrice, featured, dan sort; penerapannya bergantung pada koleksi. fieldQuery tervalidasi adalah ekstensi platform; instalasi mandiri menolaknya dengan 400.

Penerapan, origin, dan kompatibilitas

Runtime publik platform membaca versi situs yang terbit. CMS-managed dan CMS-only menyediakan pembacaan publik terkini. Site-only hanya berisi HTML dan aset statis, tanpa API konten. CMS-only tidak memiliki renderer situs. Jangan menaruh kunci pengelolaan di frontend.

Rute platform /projects/slug/{slug} tetap tersedia. Rute mandiri /api/content/collections/{collectionKey}/entries tetap tersedia dengan metadata di dalam pagination. Integrasi baru memakai v1 dan kontrak OpenAPI-nya.

Tangani 404 untuk konten terbit yang tidak ditemukan dan 400 untuk filter tidak valid. Untuk 429, ikuti Retry-After. Konfigurasikan origin frontend yang diizinkan sesuai panduan pengelolaan.

Untuk autentikasi, CORS, penulisan, dan perbedaan penerapan, lihat Menggunakan API situs / CMS.

Apakah panduan ini membantu?

Terakhir diperbarui pada

Di halaman ini