microCMS API 連携 | Studio Help

注意：外部サービス連携について

本手順には外部サービスでの操作が含まれます。外部サービスの仕様や動作、この記事に記載していない操作については、チャット窓口のサポート対象外となる場合があります。
記事内の外部サービスの画面や仕様は2026年4月時点の情報です。実際の画面が異なる場合は、各外部サービスの公式ドキュメントで最新情報を確認してください。

手順 1. microCMSでAPI認証に必要な情報を取得する

Tips：microCMSでは、APIをリスト形式とオブジェクト形式で作成できますが、Studioが対応しているのはリスト形式のみです。

microCMSで、対象のコンテンツAPIの一覧画面を開きます。
画面右上の[APIプレビュー]ボタンをクリックします。
表示されたAPI情報から、[Headers]に表示されるヘッダーキーと値を確認します。
- ヘッダーキー：X-MICROCMS-API-KEY
- 値：microCMSで発行される固有の文字列

注意：microCMS側で、一覧画面に表示されているコンテンツを最低1件以上「公開中」にしてください。 microCMSのコンテンツが非公開（下書き中または公開終了）の場合、そのコンテンツは公開サイトだけでなく、エディターやライブプレビューにも表示されません。

手順2. StudioのデザインエディタでAPI認証を追加する

Studio デザインエディタで、microCMS APIにアクセスするための認証情報を登録します。

Studioでデザインエディタを開きます。
エディタ画面左のナビゲーションから、[接続]アイコンを選択します。
[API]タブを選択します。
[認証]の[+]、または[+追加]ボタンをクリックして、API認証を追加します。
表示されたダイアログで、次の項目を入力します。
- 名前：認証の名称を任意で設定します。
- キー：手順1で確認したヘッダーキー X-MICROCMS-API-KEY を入力します。
- 値：手順1でコピーした認証用ヘッダーキーの値を入力します。
[保存]をクリックして、認証情報を保存します。
保存が完了したら、認証ダイアログ外のグレーの部分をクリックしてスクリーンに戻ります。

手順 3. microCMSで、エンドポイント設定に必要な情報を取得する

microCMS側で、一覧データまたは詳細データを取得するためのエンドポイントURLやコンテンツIDを確認します。

一覧データを取得する場合

microCMSで、対象のコンテンツAPIの一覧画面を開きます。
画面右上の[APIプレビュー]ボタンをクリックします。
画面上部に表示されたエンドポイント（URL）をコピーします。

詳細データを取得する場合

詳細データを取得する場合は、エンドポイントURLに加え、プレースホルダーパラメータとして利用するコンテンツIDを確認します。

一覧データと同様に、microCMSでエンドポイント（URL）を確認します。
コンテンツAPIの一覧画面に戻り、任意のコンテンツを1件選択します。
ここで選択したコンテンツが、Studioのデザインエディタ上のスクリーンで表示されます。
選択したコンテンツの詳細画面で、[コンテンツID]に表示される文字列をコピーします。

手順4. APIのエンドポイントの設定をする

Studio デザインエディタで、microCMSのエンドポイントを登録します。

Studioでデザインエディタを開きます。
エディタ画面左のナビゲーションから、[接続]アイコンを選択します。
[API]タブを選択します。
[エンドポイント]の[+]、または[+追加]ボタンをクリックして、エンドポイントを追加します。
表示された画面で、手順3で確認したエンドポイントURLやパラメータの値をもとに、次の項目を設定します。
- 名前：エンドポイントの名称を設定します。（例：ブログ一覧、ブログ詳細）
- URL：手順3で取得したエンドポイントURLを入力します。詳細データを取得する場合は、手順3で取得したエンドポイントURLの末尾に /:id を追加します。
  - 一覧データ：例 https://example.com/api/items
  - 詳細データ：例 https://example.com/api/items/:id
- レスポンスタイプ：[一覧]（リスト形式）または[詳細]（記事の詳細）を選択します。
- 認証：手順2で追加したAPI認証情報を選択します。認証を登録していない場合は、[+ 新規作成]から追加します。
- リクエストヘッダー（任意）：必要に応じて、X-MICROCMS-API-KEY などのヘッダーを入力します。
- プレースホルダーパラメータ：詳細データ取得時のみ、以下の情報を入力します。
  - キー： :id
  - 値：手順3で確認した、[コンテンツID]の文字列
画面右上でHTTPメソッドを[GET]に設定し、[接続を確認]ボタンをクリックします。
確認が成功すると、画面右に取得したAPIのサンプル情報が表示されます。