チュートリアル

操作マニュアル

コンテンツAPI

マネジメントAPI（ベータ）

画像API

トップ
マネジメントAPI （ベータ）

マネジメントAPIとは

最終更新日:2023年09月25日

Information

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

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

エンドポイント

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

Information

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

権限設定

マネジメントAPIは、APIキーに権限を付与することで利用することができます。

詳細はAPIキーのドキュメントをご確認ください。

APIキー（X-MICROCMS-API-KEY）: https://document.microcms.io/content-api/x-microcms-api-key

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