コンテンツにスキップ
KARTE Craft Developer Portal

CDN APIとPreview APIの概要

CDN APIとPreview APIは、Craft Cross CMSに登録したコンテンツを取得するためのAPIです。WebサイトやアプリなどのクライアントからCDN（Content Delivery Network）経由でコンテンツを読み取り、画面に表示する用途で利用します。どちらも参照専用で、コンテンツの作成や更新は行いません。

CDN APIとPreview APIの違い

2つのAPIは、取得できるコンテンツの状態が異なります。

  • CDN API
    • 公開済みのコンテンツを取得します
    • 本番のWebサイトやアプリでコンテンツを配信する用途で利用します
  • Preview API
    • 公開前の下書きを含めたコンテンツを取得します
    • 公開する前に、編集中の内容を画面上で確認する用途で利用します
API取得できるコンテンツ主な用途
CDN API公開済みのコンテンツ本番サイトでのコンテンツ配信
Preview API下書きを含むすべてのコンテンツ公開前のコンテンツの確認

認証

CDN APIとPreview APIは、KARTEのAPI v2アプリで発行したアクセストークンで認証します。アプリの作成方法、スコープ、CDN APIとPreview APIでアプリを分ける理由は、API v2アプリと認証を参照してください。

このセクションの構成

CDN APIとPreview APIは、エンドポイントとスコープが異なるだけで、リクエストの送り方やクエリの指定方法は共通です。このセクションでは次の順で説明します。

  • リクエスト: エンドポイント、アクセストークンの渡し方、リクエストの基本形
  • メソッド: 取得できるコンテンツの種類とレスポンスの構造
  • クエリ: 取得するコンテンツを絞り込む filter や select などの指定方法
  • エラー: エラー時に返るステータスコード

各メソッドのパラメータやスコープの詳細は、Craft Cross CMSのAPIリファレンスも参照してください。