सार्वजनिक सामग्री API कॉल करें
API v1 से प्रकाशित सामग्री पढ़ें और पृष्ठांकन, वैकल्पिक भाषा तथा headless परिनियोजन समझें।
सार्वजनिक सामग्री API कॉल करें
बाहरी frontend या सामग्री उपभोक्ता के लिए सार्वजनिक API इस्तेमाल करें। प्रकाशित प्रविष्टि को API कुंजी नहीं चाहिए। ड्राफ़्ट और संग्रहित प्रविष्टियाँ छिपी हैं; आगे के संपादन प्रकाशन तक निजी रहते हैं।
पहचान और endpoint चुनें
QOKIT_API_URL को API या स्थापना origin, 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सभी पृष्ठ और एक प्रविष्टि पढ़ें
क्लाइंट डाउनलोड करने की सेटिंग यहाँ देखें: साइट / CMS API का उपयोग.
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 से अस्वीकार करती है।
परिनियोजन, origin और संगतता
प्लेटफ़ॉर्म सार्वजनिक 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 origin सेट करें।
प्रमाणीकरण, CORS, लेखन और परिनियोजन अंतर के लिए देखें साइट / CMS API का उपयोग.
अंतिम बार अपडेट किया गया: