概要

microCMSは、APIを通じてコンテンツを扱う日本製のヘッドレスCMSです。管理画面で情報を入稿し、そのデータをWebサイトやアプリ側で取得して利用します。[1][3]

管理する内容と表示する画面を分けて考える点が特徴です。たとえば、お知らせの本文を編集する作業と、そのお知らせをサイト上に配置する実装は、別の役割として整理できます。

管理画面とコンテンツAPI

管理画面は編集者が内容を入稿する入口、コンテンツAPIはプログラムからデータを取得・登録する入口です。APIは読み取り専用ではありません。[2][3]

コンテンツAPIのGETは内容の取得、PUTは指定したコンテンツIDでの作成、PATCHは登録済みの内容の更新を担います。作成には、IDを自動生成する方法も用意されています。利用できる操作はAPIキーの権限で制限します。[2]

編集者による通常の更新と、外部プログラムによる登録を分けると、誰がどの経路で内容を変更するのかを整理できます。

表示側の実装との役割分担

表示側の実装は、APIから受け取った情報を、利用者が見る画面に組み立てる役割です。公式の導入文書でも、サービス側の設定とは別に、Webサイトやアプリの表示部分を用意する関係を示しています。[1]

APIで取得したデータを使って画面を作るため、管理画面への入稿だけでサイト全体のデザインや公開先まで決まるわけではありません。フロントエンドの担当者と、編集・公開の担当者が、更新内容をいつ画面へ反映するかを共有しておく必要があります。

APIキーと権限・公開設計

公開設計では、APIへのアクセスと、利用者に見せる範囲を分けて確認します。認証にはAPIキーを使い、権限で操作を制御します。[2]

  • 取得や書き込みなど、プログラムに必要な操作を整理する。
  • キーを扱う担当と、その保管・受け渡しの方法を決める。
  • 公開前の確認内容と、公開サイトへ反映する内容を区別する。
  • APIの設定変更と、表示側の実装変更を誰が確認するか決める。

これらは運用を設計する際の確認点です。実際のキー値や、個別サイトの実装手順とは分けて扱います。

参考文献・出典

  • Supervisor
    supervisor

    桑田 陽介

    代表取締役

    Web制作・運用・改善に20年以上携わり、WordPress、CMS構築、SEO、AWSなど、Webサイトの企画・制作から公開後の運用まで幅広く担当。実務経験にもとづき、本記事の内容・表現・技術情報を監修しています。

Contact us

『ホームページ制作の相談をしたい』『もっとたくさん商品を売りたい』等、ご要望をお伝えくださいませ。

疑問に思っていること、お困りごと、具体的な内容が未定でも、まずはお気軽にご相談くださいませ。