Skip to Content
Documentación para desarrolladores

Llamar a la API pública de contenido

Lee contenido publicado con API v1, paginación, idiomas de respaldo y despliegues headless.

Llamar a la API pública de contenido

Usa la API pública en frontends externos y consumidores de contenido. Las entradas publicadas no necesitan clave API. Los borradores y archivos permanecen ocultos; las ediciones posteriores no son públicas hasta su publicación.

Elegir identificadores y endpoints

Configura QOKIT_API_URL con el origen de API o instalación, QOKIT_PROJECT_SLUG con el slug del proyecto y QOKIT_COLLECTION_KEY con la clave de colección. Estas rutas usan slugs y claves; las de gestión usan IDs.

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

Leer todas las páginas y una entrada

Descarga el cliente siguiendo la configuración de Usar la API de sitios / 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);

Interpretar la respuesta

Las listas devuelven entries, page, pageSize, total y totalPages; los detalles, entry. El tamaño predeterminado es 24 y el máximo 100. Leer solo la primera página no obtiene toda la colección.

Usa el locale devuelto al enlazar entradas. localeFallback contiene requestedLocale, resolvedLocale y usedFallback. La secuencia es idioma regional, idioma base, predeterminado del proyecto e inglés. El campo superior requestedLocale depende del despliegue.

Consulta el contrato para search, category, brand, minPrice, maxPrice, featured y sort; su aplicación depende de la colección. fieldQuery validado es una extensión de plataforma; las instalaciones independientes lo rechazan con 400.

Despliegue, orígenes y compatibilidad

El runtime público de la plataforma lee la versión publicada. CMS-managed y CMS-only ofrecen lecturas públicas en vivo. Site-only contiene solo HTML y recursos estáticos, sin API de contenido. CMS-only no renderiza sitios. Nunca incluyas claves de gestión en código frontend.

Se mantienen las rutas de plataforma /projects/slug/{slug} y las independientes /api/content/collections/{collectionKey}/entries, estas últimas con metadatos anidados en pagination. Las nuevas integraciones usan v1 y su contrato OpenAPI.

Gestiona 404 cuando falte contenido publicado y 400 para filtros no válidos. Ante 429, respeta Retry-After. Configura los orígenes frontend permitidos según la guía de gestión.

Para autenticación, CORS, escrituras y diferencias de despliegue, consulta Usar la API de sitios / CMS.

¿Te ha resultado útil esta guía?

Última actualización

En esta página