Skip to Content
Tài liệu dành cho nhà phát triển

Gọi API nội dung công khai

Đọc nội dung đã xuất bản qua API v1 với phân trang, ngôn ngữ dự phòng và triển khai headless.

Gọi API nội dung công khai

Dùng API công khai cho frontend ngoài hoặc hệ thống đọc nội dung. Mục đã xuất bản không cần khóa API. Bản nháp và mục lưu trữ bị ẩn; chỉnh sửa tiếp theo riêng tư đến khi xuất bản.

Chọn định danh và endpoint

Đặt QOKIT_API_URL thành origin API hoặc cài đặt, QOKIT_PROJECT_SLUG thành slug dự án, QOKIT_COLLECTION_KEY thành khóa bộ sưu tập. Tuyến này dùng slug và khóa; quản lý dùng ID tài nguyên.

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

Đọc toàn bộ trang và một mục

Tải client theo cấu hình trong Sử dụng API trang web / 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);

Hiểu phản hồi

Danh sách trả về entries, page, pageSize, total, totalPages; chi tiết trả về entry. Mặc định 24, tối đa 100. Chỉ đọc trang đầu không lấy toàn bộ bộ sưu tập.

Dùng locale được trả về cho liên kết. localeFallback chứa requestedLocale, resolvedLocale, usedFallback. Thứ tự là ngôn ngữ vùng, ngôn ngữ gốc, mặc định dự án, tiếng Anh. Trường cấp cao requestedLocale tùy bản triển khai.

Xem hợp đồng cho search, category, brand, minPrice, maxPrice, featured, sort; áp dụng tùy bộ sưu tập. fieldQuery được kiểm tra là mở rộng nền tảng; cài đặt độc lập từ chối với 400.

Triển khai, origin và tương thích

Runtime công khai nền tảng đọc phiên bản trang web đã xuất bản. CMS-managed và CMS-only hỗ trợ nội dung CMS công khai hiện tại. Site-only chỉ chứa HTML và tài nguyên tĩnh, không có API nội dung. CMS-only không có bộ kết xuất trang web. Không đặt khóa quản lý trong frontend.

Tuyến nền tảng /projects/slug/{slug} vẫn hoạt động. Tuyến độc lập /api/content/collections/{collectionKey}/entries vẫn hoạt động với siêu dữ liệu lồng trong pagination. Tích hợp mới dùng v1 và hợp đồng OpenAPI.

Xử lý 404 khi thiếu nội dung đã xuất bản và 400 với bộ lọc không hợp lệ. Với 429, tuân theo Retry-After. Cấu hình origin frontend được phép theo hướng dẫn quản lý.

Về xác thực, CORS, ghi và khác biệt triển khai, xem Sử dụng API trang web / CMS.

Hướng dẫn này có hữu ích không?

Cập nhật lần cuối vào

Trong trang này