Açık içerik API çağrıları
API v1 ile yayımlanmış içeriği, sayfalamayı, dil yedeğini ve headless dağıtımları kullanın.
Açık içerik API çağrıları
Dış frontend veya içerik tüketicileri için açık API kullanın. Yayımlanmış kayıtlar API anahtarı istemez. Taslak ve arşivler gizlidir; sonraki düzenlemeler yayımlanana kadar özel kalır.
Tanımlayıcı ve endpoint seçimi
QOKIT_API_URL için API veya kurulum origin adresini, QOKIT_PROJECT_SLUG için proje slug değerini, QOKIT_COLLECTION_KEY için koleksiyon anahtarını ayarlayın. Bu yollar slug ve anahtar, yönetim yolları kaynak kimliği kullanır.
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=enTüm sayfaları ve bir kaydı okuma
İstemciyi şu kurulum adımlarına göre indirin: Site / CMS API kullanımı.
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);Yanıtı anlama
Listeler entries, page, pageSize, total, totalPages; ayrıntılar entry döndürür. Varsayılan boyut 24, en yüksek 100’dür. İlk sayfa bütün koleksiyonu içermez.
Kayıt bağlantılarında dönen locale kullanılır. localeFallback içinde requestedLocale, resolvedLocale, usedFallback vardır. Sıra bölgesel dil, temel dil, proje varsayılanı ve İngilizcedir. Üst düzey requestedLocale dağıtıma bağlıdır.
search, category, brand, minPrice, maxPrice, featured, sort için hizmet sözleşmesine bakın; kullanım koleksiyona bağlıdır. Doğrulanmış fieldQuery platform eklentisidir; bağımsız kurulumlar 400 ile reddeder.
Dağıtım, origin ve uyumluluk
Platformun açık runtime servisi yayımlanan site sürümünü okur. CMS-managed ve CMS-only güncel açık CMS okumalarını sağlar. Site-only yalnızca statik HTML ve varlıklar içerir; içerik API'si yoktur. CMS-only site renderer içermez. Yönetim anahtarını frontend koduna koymayın.
Platform /projects/slug/{slug} yolları korunur. Bağımsız /api/content/collections/{collectionKey}/entries yolları da iç içe pagination bilgisiyle korunur. Yeni entegrasyonlar v1 ve OpenAPI sözleşmesini kullanır.
Yayımlanmış içerik yoksa 404, geçersiz filtrede 400 işleyin. 429 için Retry-After izleyin. İzinli frontend origin adreslerini yönetim kılavuzuna göre yapılandırın.
Kimlik doğrulama, CORS, yazmalar ve dağıtım farkları için bkz. Site / CMS API kullanımı.
Son güncelleme tarihi: