Appeler l’API publique de contenu
Lisez le contenu publié avec API v1, pagination, repli de langue et déploiements headless.
Appeler l’API publique de contenu
Utilisez l’API publique pour un frontend externe ou un consommateur de contenu. Les entrées publiées ne nécessitent aucune clé. Brouillons et archives sont masqués ; les nouvelles modifications restent privées jusqu’à publication.
Choisir les identifiants et endpoints
Définissez QOKIT_API_URL sur l’origine API ou installation, QOKIT_PROJECT_SLUG sur le slug du projet et QOKIT_COLLECTION_KEY sur la clé de collection. Ces routes utilisent slugs et clés ; la gestion utilise des identifiants de ressources.
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=enLire toutes les pages et une entrée
Téléchargez le client selon la configuration décrite dans Utiliser l’API de site / 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);Interpréter la réponse
Les listes renvoient entries, page, pageSize, total et totalPages ; le détail renvoie entry. Taille par défaut : 24, maximum : 100. La première page ne contient pas toute la collection.
Utilisez le locale retourné pour les liens. localeFallback contient requestedLocale, resolvedLocale et usedFallback. Ordre : langue régionale, langue de base, défaut du projet, anglais. Le champ supérieur requestedLocale dépend du déploiement.
Consultez le contrat pour search, category, brand, minPrice, maxPrice, featured et sort ; leur application dépend de la collection. fieldQuery validé est une extension plateforme ; les installations indépendantes le refusent avec 400.
Déploiement, origines et compatibilité
Le runtime public de la plateforme lit la version publiée du site. CMS-managed et CMS-only lisent le CMS public actuel. Site-only ne contient que du HTML et des ressources statiques, sans API de contenu. CMS-only ne rend pas de sites. Ne placez jamais de clé de gestion dans le frontend.
Les routes plateforme /projects/slug/{slug} restent disponibles. Les routes indépendantes /api/content/collections/{collectionKey}/entries restent disponibles avec métadonnées imbriquées dans pagination. Les nouvelles intégrations utilisent v1 et son contrat OpenAPI.
Gérez 404 pour un contenu publié absent et 400 pour des filtres invalides. Pour 429, respectez Retry-After. Configurez les origines frontend autorisées selon le guide de gestion.
Pour l’authentification, CORS, les écritures et les différences de déploiement, consultez Utiliser l’API de site / CMS.
Dernière mise à jour