API v2アプリと認証

Craft Cross CMSのコンテンツやメディアをAPIで取得、操作するには、APIごとに定められた方法で認証します。CDN API・Preview API・Management APIは、KARTEのAPI v2アプリで発行するアクセストークンを使います。Assets APIは、プロジェクトのAPIキーを使います。

APIの種類

Craft Cross CMSには、用途の異なる次のAPIがあります。認証情報もAPIによって異なります。

API	用途	認証情報
CDN API	公開済みのコンテンツをCDN経由で配信する	アクセストークン
Preview API	公開前のコンテンツを確認する	アクセストークン
Assets API	メディア（画像、動画など）を配信する	APIキー
Management API	バックエンドからコンテンツやモデルを操作する	アクセストークン

Assets APIのAPIキーは、API v2アプリではなく、プロジェクトごとに発行されるキーです。メディアライブラリでアセットの配信用URLをコピーすると、その中に含まれています。アクセストークンを発行するAPI v2アプリの作成は、Assets APIには不要です。

API v2アプリの作成

APIを利用するには、KARTE管理画面でAPI v2アプリを作成し、アクセストークンを発行します。

KARTE管理画面にログインし、[すべてのメニュー]>[ストア]>[API v2設定]を選択します
アプリを作成し、タイプと、利用するAPIに必要なスコープ（パーミッション）を設定します
保存すると、アクセストークンが表示されます

アプリのタイプ

タイプは、利用するAPIに応じて次のように指定します。

CDN API、Preview APIを利用する場合: CDN
Management APIを利用する場合: token

スコープ

アプリには、実行したいAPIに対応するスコープ（パーミッション）を設定します。たとえば、CDN APIでコンテンツ一覧を取得するには次のスコープが必要です。

beta.cdn.cms.content.list

各APIに必要なスコープは、Craft Cross CMSのAPIリファレンスで確認できます。

token タイプのアプリでは、スコープの一覧に他プロダクトのものも表示されるため、数が多く目的のスコープを探しにくい場合があります。検索バーに cms と入力すると、Craft Cross CMS関連のスコープだけに絞り込めます。

スコープの追加に必要な権限

アプリにスコープを追加するには、操作するKARTEアカウントに「Craft設定の編集」の権限が必要です。この権限は、KARTEの権限グループで「Craft」の「Craft設定の編集」を有効にすると付与されます。権限が不足している場合、API v2アプリにCraft Cross CMSのスコープを追加できません。

Craft設定の編集の権限

権限グループの確認、設定方法は、権限とロールを参照してください。

CDN APIとPreview APIはアプリを分ける

CDN APIは公開済みのコンテンツを、Preview APIは公開前のものも含めたすべてのコンテンツを取得します。どちらも CDN タイプのアプリで利用するため、1つのアプリに両方のスコープをまとめて設定できます。

しかし、フロントエンドなどアクセストークンが第三者の目に触れる場所で利用する場合は、CDN APIとPreview APIでアプリを分けることを強く推奨します。これはセキュリティ上、特に重要な設定です。理由は次のとおりです。

APIエンドポイントの確認

CDN API、Preview API、Assets APIのエンドポイントには、プロジェクト固有のサブドメインが含まれます。サブドメインは、KARTE管理画面の[すべてのメニュー]>[Craft]>[CMS設定]>[APIエンドポイント]で確認できます。

サブドメイン