こんにちは！更新情報のお知らせです。

API情報取得のマネジメントAPIがリリースされました。
microCMSにはコンテンツを扱う「コンテンツAPI」と管理画面内の操作を扱う「マネジメントAPI」の2種類のAPIがありますが、今回の変更はマネジメントAPIでご利用いただけます。

この記事では基本的な使い方についてご紹介します。
APIの詳細については、ドキュメントの「GET /api/v1/apis/{endpoint}」をご覧ください。

API情報取得のマネジメントAPIについて

新しくサポートするリクエストは GET /api/v1/apis/{endpoint} です。
このAPIを使用することで、指定したAPIのスキーマ情報（フィールド定義やカスタムフィールドの構成）をプログラムから取得できるようになります。

利用方法

APIキーに権限を付与する

API情報の取得をAPIから利用するためには、APIキーに権限を付与する必要があります。
管理画面のAPIキー設定より、適切な権限を追加してください。

API経由でAPI情報を取得する

curlコマンドを利用する場合、以下のようなリクエストを送ってください。
（API_KEY、SERVICE_ID、ENDPOINTはご自身のものに差し替えてください）

curl -X GET "https://<SERVICE_ID>.microcms-management.io/api/v1/apis/<ENDPOINT>" -H "X-MICROCMS-API-KEY: <API_KEY>"

レスポンス例

例えば以下のようなAPIを作っていて、このAPIの情報を取得するとします。


 APIリクエストが成功すると、以下のような形式でAPI情報が返されます：

{
  "apiFields": [
    {
      "fieldId": "title",
      "name": "タイトル",
      "kind": "text",
      "required": false
    },
    {
      "fieldId": "body",
      "name": "本文",
      "kind": "richEditorV2",
      "required": false
    },
    {
      "fieldId": "tags",
      "name": "タグ",
      "kind": "select",
      "required": false,
      "multipleSelect": true,
      "selectInitialValue": [],
      "selectItems": [
        {
          "id": "Hc1QzudmqV",
          "value": "更新情報"
        },
        {
          "id": "Fx0fDbBj7S",
          "value": "チュートリアル"
        },
        {
          "id": "_SczHMUJgH",
          "value": "お知らせ"
        }
      ]
    }
  ],
  "customFields": []
}

これまでも管理画面の「APIスキーマ設定」からAPIスキーマのダウンロードができましたが、それをAPI経由で行えるようになった形です。
APIで取得したスキーマ定義を使って新規にAPIを作成することも可能です。

ユースケース

API情報取得のマネジメントAPIは以下のようなシーンで便利にお使いいただけます。

外部システムとの連携

他のシステムとmicroCMSを連携する際に、APIのスキーマ情報をプログラムから取得してデータ変換や処理に活用できます。
カスタムフィールドの詳細な構成も取得できるため、複雑なデータ構造にも対応可能です。

MCPサーバーを介しての利用

microcms-mcp-serverを使うとChatGPTやClaudeからコンテンツの読み書きができますが、これまでは最初にスキーマ情報を与える必要がありました。
今回のアップデートによりAIにエンドポイントを教えるだけでスキーマを自動的に理解してもらえるようになります。
（対応版のmicrocms-mcp-serverは近日公開予定です）

おわりに

今回はAPI情報取得のマネジメントAPIについて紹介しました。
より使いやすいサービスを目指してAPI、管理画面ともに改善してまいります。ご要望などございましたら管理画面右下のチャットボタンよりご意見いただけますと幸いです。