マネジメントAPIとは
最終更新日:2024年10月09日
Information現在はこちらの機能はベータ版でご提供しております。
マネジメントAPIを用いることで、管理画面内の情報取得や操作を、API経由で行うことができます。例えば、コンテンツであれば、公開予約日時の取得や公開状態の変更が可能です。
ベースURL
https://{SERVICE_ID}.microcms-management.io
- Information
コンテンツAPIとはドメインが異なります。ご注意ください。
仕様
マネジメントAPIの利用には、APIキーによる認証が必要となります。APIキーに対しては、権限を付与することで利用可能な操作を制限することができます。詳細はAPIキーのドキュメントをご確認ください。
- APIキー（APIの認証と権限管理）
- https://document.microcms.io/content-api/x-microcms-api-key
制限事項
- マネジメント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
- PATCH /api/v1/contents/{endpoint}/{content_id}/createdBy
- https://document.microcms.io/management-api/patch-contents-created-by
メディア
メディア（画像、ファイル）に関連する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
- DELETE /api/v2/media
- https://document.microcms.io/management-api/delete-media-v2