下津曲 浩
こんにちは！カスタマーエンジニアの下津曲です。
microCMSではメインでご利用いただくコンテンツAPIの他に、マネジメントAPIというAPIがあります。両者には以下のような役割の違いがあります。
- コンテンツAPI：データの取得や登録を行うための基本的なAPI。通常はこちらを利用する。
- マネジメントAPI：コンテンツのメタ情報やメディアを取得したり、操作したりできるAPI。管理画面内での操作をAPI経由で実行したいときに利用する。
マネジメントAPIは2024年6月時点ではまだβ版でありながらも、新規開発および機能追加は日々行われており、さまざまなエンドポイントが存在しています。
それらは、データの移行時や他のシステムと連携してワークフローを組む際などに便利にお使いいただけるものばかりです。
今回はそんな、ワークフロー構築を影で支えるマネジメントAPIの活用シーンをいくつかご紹介いたします。
1. コンテンツのメタ情報を含めて取得する
通常、microCMSでコンテンツを取得する際は、コンテンツAPIを利用することが多いと思います。
マネジメントAPIでも同様にコンテンツを取得するためのエンドポイントが存在し、それらを活用することで以下のようなメタ情報を含むコンテンツデータを取得できます。
- コンテンツの公開状態（
"DRAFT"、"PUBLISH"など） - カスタムステータス
- コンテンツの作成者／最終更新者
- 予約時間
例えば他のシステムと連携してデータを活用したいケースや、バックアップ目的でメタ情報も含めてコンテンツを取得したいケースなどでご活用いただけます。
【対象のマネジメントAPI】
2. コンテンツの作成者を変更する
microCMSではコンテンツの作成者を任意のメンバーに割り当てることができます。
これまでは、コンテンツの作成者を変更する際はコンテンツ編集画面からUI操作で対応する必要がありました。
そんななか、2024年5月にコンテンツ作成者変更のためのエンドポイントが追加され、こちらの操作をマネジメントAPIで対応できるようになりました。
（参考ブログ：API経由でコンテンツの作成者を変更できるようになりました）
メンバーの異動や退職により作成者を変更したいケースや、APIで入稿したコンテンツの作成者（デフォルトでは作成者は「API」となります）に任意のメンバーを割り当てるケースにご活用いただけます。
【対象のマネジメントAPI】
3. コンテンツの公開状態を変更する
マネジメントAPIを使うことで、コンテンツの公開状態を変更することができます。
現在対応しているのは、「下書き中」→「公開中」と「公開中」→「下書き中」への変更です。
例えば、システムと連携してワークフローのなかで公開状態を変更したいケースなどでご活用いただけます。
【対象のマネジメントAPI】
4. メディアをアップロード／取得／削除する
microCMSでは、メディアはコンテンツとは独立して管理されています。このメディアに関する操作も、マネジメントAPIで対応できるようになっています。
具体的には、アップロード／取得／削除の操作がAPIで対応できます。
それぞれ、以下のようなシーンでご活用いただけます。
- アップロード：他のCMSからの移行や多数のメディアを一気にアップロードしたいときなど
- 取得：microCMS内のメディアをバックアップしたいときなど
- 削除：コンテンツ削除に伴い不要なメディアを削除したいときなど
【対象のマネジメントAPI】
注意事項
マネジメントAPIを利用する際は、APIキーの権限設定が必要です。
具体的には、「APIキー管理」>「マネジメントAPI（ベータ）」タブ > 権限設定で、任意の権限にチェックを入れてお使いください。
さいごに
Webサイトやアプリ開発で主にご利用いただくコンテンツAPIだけでなく、マネジメントAPIも少しずつ機能開発を進めています。
マネジメントAPIはシステム連携を伴うワークフローを構築するうえで強力な味方となります。ぜひ取り入れて活用してみてください。
また、APIに関するユーザーのみなさまのお声もお待ちしています。ご要望などございましたら管理画面右下のチャットボタンよりご意見いただけますと幸いです。
