microCMS

マネジメントAPIとは

最終更新日:2024年01月24日
informationInformation

現在はこちらの機能はベータ版でのこ提供となります。

マネジメントAPIを用いることで、管理画面内の情報取得や操作を、API経由で行うことができます。例えば、コンテンツであれば、公開予約日時の取得や公開状態の変更が可能です。

ベースURL

https://{SERVICE_ID}.microcms-management.io

informationInformation

コンテンツAPIとはドメインが異なります。ご注意ください。

仕様

マネジメントAPIの利用には、APIキーによる認証が必要となります。APIキーに対しては、権限を付与することで利用可能な操作を制限することができます。詳細はAPIキーのドキュメントをご確認ください。

APIキー(APIの認証と権限管理)
https://document.microcms.io/content-api/x-microcms-api-key

制限事項

  • マネジメントAPIの全体に関わる制限事項については、制限事項のドキュメントをご参照ください。
  • 各APIにおける制限事項は、それぞれの個別ページをご参照ください。

APIの種類

コンテンツ

コンテンツに関連するAPIです。
コンテンツAPIとの違いとして、コンテンツの作成者やステータスなど、管理画面内のみ閲覧可能な情報の取得が可能となっています。

GET /api/v1/contents/{endpoint}
https://document.microcms.io/management-api/get-list-contents-management
GET /api/v1/contents/{endpoint}/{content_id}
https://document.microcms.io/management-api/get-content
PATCH /api/v1/contents/{endpoint}/{content_id}/status
https://document.microcms.io/management-api/patch-contents-status

メディア

メディア(画像、ファイル)に関連するAPIです。

GET /api/v1/media
https://document.microcms.io/management-api/get-media
GET /api/v2/media
https://document.microcms.io/management-api/get-media-v2
POST /api/v1/media
https://document.microcms.io/management-api/post-media