こんにちは！更新情報のお知らせです。

API経由でmicroCMSに画像をアップロードできるようになりました。
画像のアップロードにはマネジメントAPIを利用します。

この記事では基本的な使い方についてご紹介します。
APIの詳細については、ドキュメントの「POST /api/v1/media」をご覧ください。

画像アップロードAPIについて

マネジメントAPIは管理画面での操作同等のアクションが可能なAPIです。今回はそのマネジメントAPIに新しい機能が追加されました。

新しくサポートするリクエストは POST /api/v1/media です。
画像をどのようにアップロードできるのか、具体的な利用方法を見てみましょう。

利用方法

APIキーに権限を付与する

画像アップロードを使うためには、APIキーに新たに権限を付与する必要があります。
管理画面のAPIキー設定より、「メディアのアップロード」の権限を追加します。

API経由で画像をアップロードする

curlコマンドを利用する場合、以下のようなリクエストを送ってください。
（API_KEYとSERVICE_IDはご自身のものに差し替えてください）

curl -X POST -H 'X-MICROCMS-API-KEY: <API_KEY>' \
  -F "file=@cat.jpg" \
  https://<SERVICE_ID>.microcms-management.io/api/v1/media

アップロードが成功すると画像URLがレスポンスされます。

{"url":"https://images.microcms-assets.io/assets/7f8db1ce8c504b42b23d9abefd37c803/1532be0fd7b24d54a7590546e7a188f5/cat.jpg"}

制限事項／ご注意

• 画像アップロードAPIでアップロードできるサイズ上限は5MBまでです。それ以上のサイズは管理画面からアップロードしてください。
• アップロードできるメディアタイプは画像のみです。
• 本機能は画像をアップロードするのみで、画像フィールド／複数画像フィールドに登録できるものではございません。

ユースケース例

例えば、画像アップロードAPIは以下のようなシーンで便利にお使いいただけます。

手元にある大量の画像を一挙に登録したいとき

別のCMSからの移行時など登録したい画像が多い場合、手動では手間がかかりますがAPI経由なら簡単です。

一連のワークフローに、画像をアップロードする処理を組み込みたいとき

自社システムに画像がアップロードされた場合にmicroCMSにも画像をアップロードしたり、
リサイズ・加工してから画像をアップロードするなど、ワークフローに柔軟に合わせられます。

【2024年2月26日 追記】
2024年2月26日のリリースで、画像、複数画像、ファイルフィールドにAPI経由でコンテンツを入稿できるようになりました。
こちらのAPIと組み合わせることで、さらに柔軟なコンテンツ入稿フローを組むことが可能です。microCMSへのコンテンツの移行の際などにぜひお使いください！

詳細は以下のリリースブログをご覧ください。

画像、複数画像、ファイルフィールドにAPI経由でコンテンツを入稿できるようになりました
https://blog.microcms.io/update-content-api-media-adaption/

おわりに

画像アップロードのマネジメントAPIについて紹介しました。
このAPIをより簡単に使えるようにSDKでも提供予定です。こちらは続報をお待ちください。