Skip to Content
開発者ドキュメント

公開コンテンツ API を呼び出す

API v1 で公開コンテンツを読み取り、ページ分割、言語フォールバック、headless 配置を扱います。

公開コンテンツ API を呼び出す

外部フロントエンドやコンテンツ利用システムには公開 API を使います。公開エントリーに API キーは不要です。下書きとアーカイブは非公開で、公開後の編集も再公開するまで非公開です。

識別子とエンドポイントを選ぶ

QOKIT_API_URL に 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

全ページとエントリーを読む

クライアントの取得手順は次を参照してください: サイト / CMS API を使う.

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 になります。

配置、オリジン、互換性

プラットフォームの公開 runtime は公開済みサイトバージョンを読み取ります。CMS-managed と CMS-only は現在の公開 CMS データを返します。site-only は静的 HTML とアセットのみで、コンテンツ API はありません。CMS-only にサイト描画機能はありません。管理キーをフロントエンドに置かないでください。

既存のプラットフォーム /projects/slug/{slug} ルートは維持されます。独立 /api/content/collections/{collectionKey}/entries ルートも維持され、ページ情報は pagination 内にあります。新規連携は v1 と OpenAPI 契約を使います。

公開コンテンツがない場合は 404、無効なフィルターは 400 を処理します。429 では Retry-After に従います。管理ガイドに従い許可するフロントエンドのオリジンを設定します。

認証、CORS、書き込み、配置環境の違いは次を参照してください: サイト / CMS API を使う.

このガイドは役に立ちましたか?

最終更新

このページの内容