Skip to Content
Documentação para desenvolvedores

Chamar a API pública de conteúdo

Leia conteúdo publicado com API v1, paginação, fallback de idioma e implantação headless.

Chamar a API pública de conteúdo

Use a API pública para frontends externos ou consumidores de conteúdo. Entradas publicadas não precisam de chave API. Rascunhos e arquivos são ocultos; edições posteriores ficam privadas até a publicação.

Escolher identificadores e endpoints

Defina QOKIT_API_URL como a origem API ou da instalação, QOKIT_PROJECT_SLUG como o slug do projeto e QOKIT_COLLECTION_KEY como a chave da coleção. Estas rotas usam slugs e chaves; gerenciamento usa 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

Ler todas as páginas e uma entrada

Baixe o cliente seguindo a configuração em Usar a API de sites / 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 a resposta

Listas retornam entries, page, pageSize, total e totalPages; detalhes retornam entry. O padrão é 24 e o máximo 100. Apenas a primeira página não contém toda a coleção.

Use o locale retornado ao criar links. localeFallback contém requestedLocale, resolvedLocale e usedFallback. A sequência é idioma regional, idioma base, padrão do projeto e inglês. O campo superior requestedLocale depende da implantação.

Consulte o contrato para search, category, brand, minPrice, maxPrice, featured e sort; a aplicação depende da coleção. fieldQuery validado é extensão da plataforma; instalações independentes o rejeitam com 400.

Implantação, origens e compatibilidade

O runtime público da plataforma lê a versão publicada do site. CMS-managed e CMS-only fornecem leituras públicas atuais. Site-only contém apenas HTML e recursos estáticos, sem API de conteúdo. CMS-only não renderiza sites. Nunca coloque uma chave de gerenciamento no frontend.

Rotas da plataforma /projects/slug/{slug} continuam disponíveis. Rotas independentes /api/content/collections/{collectionKey}/entries continuam com metadados aninhados em pagination. Novas integrações usam v1 e seu contrato OpenAPI.

Trate 404 quando não houver conteúdo publicado e 400 para filtros inválidos. Para 429, respeite Retry-After. Configure origens frontend permitidas conforme o guia de gerenciamento.

Para autenticação, CORS, escrita e diferenças de implantação, veja Usar a API de sites / CMS.

Este guia foi útil?

Última atualização

Nesta página