เรียก API เนื้อหาสาธารณะ
อ่านเนื้อหาที่เผยแพร่ด้วย API v1 พร้อมการแบ่งหน้า ภาษาสำรอง และการติดตั้ง headless
เรียก API เนื้อหาสาธารณะ
ใช้ API สาธารณะสำหรับ frontend ภายนอกหรือระบบอ่านเนื้อหา รายการที่เผยแพร่ไม่ต้องใช้คีย์ API ร่างและรายการในคลังถูกซ่อน การแก้ไขภายหลังยังเป็นส่วนตัวจนกว่าจะเผยแพร่
เลือกตัวระบุและ endpoint
ตั้ง QOKIT_API_URL เป็น origin 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
การติดตั้ง 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 ตั้ง origin frontend ที่อนุญาตตามคู่มือจัดการ
การยืนยันตัวตน CORS การเขียน และความแตกต่างการติดตั้ง ดู ใช้ API เว็บไซต์ / CMS.
อัปเดตล่าสุดเมื่อ