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

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

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

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

新しくサポートするリクエストは GET /api/v1/apis です。
このAPIを使用することで、APIの一覧の情報（API名とエンドポイント）をプログラムから取得できるようになります。

利用方法

APIキーに権限を付与する

API情報の取得をAPIから利用するためには、APIキーに権限を付与する必要があります。
管理画面のAPIキー設定より、「API情報の取得 (一覧・詳細)」を追加してください。

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

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

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

レスポンス例

以下のような形式でAPI一覧の情報が返されます：

{
  "apis": [
    {
      "name": "ブログ",
      "endpoint": "blogs",
      "type": "list"
    },
    {
      "name": "カテゴリ",
      "endpoint": "categories",
      "type": "list"
    },
    {
      "name": "バナー",
      "endpoint": "banner",
      "type": "object"
    }
  ]
}

type はそのAPIの形式を表します。リスト形式のAPIであれば list が、オブジェクト形式のAPIであれば object の値がセットされます。

ユースケース

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

外部システムとの連携

他のシステムとmicroCMSを連携する際に、APIの一覧情報をプログラムから取得してデータ変換や処理に活用できます。
先日リリースした APIスキーマを取得するマネジメントAPI と組み合わせるとより便利にご利用いただけます。

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

microcms-mcp-serverを使うとChatGPTやClaudeからコンテンツの読み書きができます。
これまではAPIのエンドポイント名を明示的に伝える必要がありましたが、今回のアップデートにより会話の文脈のなかでAIが参照すべきAPIを自動で選択できるようになりました。

こちらのAPIに対応したmicroCMS MCPサーバーもリリース済みです。たとえばチャットで「microCMSのAPI一覧を取得して」と伝えるだけで、API一覧を取得できるようになっています。ぜひお試しください。

おわりに

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