microCMS

マネジメントAPIとは

informationInformation

現在はこちらの機能はベータ版でご提供しております。

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

ベースURL

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

informationInformation

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

仕様

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

制限事項

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

APIの種類

サービス

サービスに関するAPIです。

コンテンツ

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

メディア

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

メンバー

メンバーに関連するAPIです。

API

管理画面で定義したAPIに関連するAPIです。