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

Craft Cross CMSでコンテンツを管理する

概要

Craft Cross CMS はKARTE Craftが提供するヘッドレスなコンテンツ管理システム（Headless Content Management System）です。 Craft Cross CMSを使うことで、ウェブサイトやアプリ上のコンテンツ（文章、画像、動画など）を専門的なプログラミング知識がなくても作成、管理、更新できます。

Craft Cross CMSはヘッドレスという特徴があります。ヘッドレスとは、フロントエンドへの表示機能を持たないことを意味します。表示機能を持たないため、コンテンツの表示方法を自由に構築できます。また複数のチャネル（Webサイト、スマホアプリ、KARTEの接客サービス、SNS..）に対してコンテンツを提供できます。

Craft Cross CMSの概念は次の図のとおりです。画面への表示機能は外部のサーバーやフロントエンドで行い、Craft Cross CMSはコンテンツの中身や、それに紐づくメディア（画像、動画、各種ファイル）を管理、配信します。

about-craft-cross-cms

機能

Craft Cross CMSは次の要素から構成されます。

コンテンツを入稿し管理する画面

  • コレクション : モデルを管理する箱です
  • モデル : コンテンツ管理の骨組みです
  • コンテンツ : 実際に配信するコンテンツです
  • メディアライブラリ : 画像、動画、そのほかファイルを管理するための仕組みです。

コンテンツを操作/配信するAPI

Craft Cross CMSでコンテンツを入稿するための要素

前述の通り、コンテンツ管理の要素は コンテンツ、モデル、コレクション と、コンテンツ内で利用するメディア（画像、動画、そのほかファイル）を管理する メディアライブラリ で構成されます。

コンテンツ、モデル、コレクションの関係は次の図のとおりです。

about-craft-cross-cms-resources

コレクションとは

コレクション とは、モデルをまとめて保管する箱です。

たとえば、「お知らせ」「ブログ記事」「スタッフ紹介」などのカテゴリごとに、別々のコレクションを作ることで、整理された状態で管理できます。

コンテンツ、モデルを作成するには、始めにコレクションを作成してください。

モデルとは

モデル とは、コンテンツ管理の骨組みとなるものです。

モデルは、1つ以上の フィールド で構成します。フィールドはコンテンツの入力項目のことで、「テキスト」「リッチテキスト」「日付」「画像」のように様々な種類があります。フィールドの組み合わせによって、入稿するコンテンツのデータ構造と入力項目が決定します。

モデルにフィールドを追加する際には、フィールドタイプ、フィールドID、フィールド名を指定してください。ユーザーの目的に応じてこれらのフィールドを適宜追加していくことで、コンテンツのデータ構造を定義できます。

たとえば、「ブログ記事」のコレクションにモデルを作る場合、「記事」、「著者」のように、異なるデータ構造ごとにモデルを作成します。

コンテンツを作成する際は、先にモデルを作成してください。

コンテンツとは

コンテンツ とは、モデルで定義された入力項目に従って実際に入力、登録したデータのことです。

前述の「ブログ記事」というコレクションの場合、次の情報がコンテンツとなります。

  • ブログ記事の一つひとつの記事：「記事」モデルのコンテンツ
  • 記事に紐づく著者情報：「著者」モデルのコンテンツ

メディアライブラリ

メディアライブラリ は画像、動画、そのほかファイルをCraft Cross CMSに保存、管理するための仕組みです。コンテンツに画像や動画のようなファイルを組み込みたい場合、メディアライブラリに保存したファイルを参照する形で実装します。

コンテンツを作成する手順

コンテンツの作成手順を説明します。

管理画面を開く

CMSのコンテンツはKARTE Craftの管理画面から作成できます。

  • KARTE管理画面にログインし、[すべてのプロダクト]>[Craft]>[CMS]を選択します。
  • [コンテンツ一覧]画面が開きます。

コレクションを新たに作成する

  • [コンテンツ設定画面]を開き、[コレクションを追加]を選択します
  • コレクション名に任意の名称を入力し、[作成]を選択します

モデルを新たに作成する

  • [コンテンツ設定]を開き、作成した[コレクション]の中で[モデルを追加]を選択します
  • モデル名に任意の名称を入力し、[作成]を選択します
  • 作成した[モデル]を選択します
  • [フィールドを追加]を選択し、任意のフィールドを選択します
  • フィールド名に任意の名称を入力します
  • フィールドIDに任意のIDを入力します
  • フィールドの説明に任意の説明を入力します
  • コンテンツ作成時に入力必須項目としたい場合は必須フィールドにチェックを入れます
  • その他フィールドの種類毎の個別設定値を適宜選択、入力します
  • [保存]を選択します

コンテンツを新たに作成する

  • [コンテンツ一覧]を開き、[投稿を追加]を選択します
  • 各フィールドを入力し、[保存]または[公開]を選択します

　※[公開]すると、CMS APIでコンテンツを取得できる状態になります。

APIを利用する

各種APIの利用方法を説明します。各APIの仕様はコンテンツを操作/配信するAPIを確認してください。

Assets APIを利用してメディアファイルを取得する

Assets APIは各種メディアのURLからアクセスします。

URLは管理画面から取得します。

  • KARTE管理画面の[すべてのプロダクト]>[Craft]>[メディアライブラリ]を開きます
  • ファイルの三点リーダー「…」から[URLをコピー]を選択します

CDN API (Preview API) を利用してWebサイトやKARTEの接客サービスなどからコンテンツを配信する

CDN API, Preview APIを利用する際は、アクセストークンが必要となります。アクセストークンを発行するには、次の手順でAPI v2のアプリを作成してください。

  • KARTE管理画面にログインし、[すべてのプロダクト]>[ストア]>[API v2設定]を選択します
  • 右上の「作成」ボタンを押します
  • アプリの設定をします
    • タイプに cdn を指定します
      • CDN APIとPreview APIを使う場合に指定するタイプです
    • パーミッション設定で実行したいAPIのスコープを選択します
      • 必要なスコープは各APIのリファレンスを確認してください
  • 「保存」を選択すると、アクセストークンが表示されます
    • アクセストークンはこのタイミング以外表示されないため、紛失しないように注意してください

作成したアプリ（アクセストークン）を用いて、前述したCDN APIのドキュメントを参考に、コンテンツを取得するためのプログラムを実装します。

Management APIを利用してコンテンツやモデルを操作する

Management APIはKARTE API v2のAPIとして利用できます。利用方法はAPI v2のドキュメントおよび各APIのリファレンスを確認してください。