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

APIを使って、「画像フィールド」、「複数画像フィールド」、「ファイルフィールド」にコンテンツを入稿できるようになりました。
microCMSはAPI経由でもコンテンツを入稿できますが、上記のフィールドは非対応でした。今回のアップデートで、すべてのフィールドをAPI経由で入稿できるようになります。

先日リリースした画像アップロードのマネジメントAPIと組み合わせることで、「画像をmicroCMSにアップロード→その画像を使ってコンテンツに入稿」の流れも滑らかに実装できます。

この記事では基本的な使い方についてご紹介します。
APIの詳細については以下のドキュメントをご覧ください。

• POST /api/v1/{endpoint}
• PUT /api/v1/{endpoint}/{content_id}
• PATCH /api/v1/{endpoint}/{content_id}

APIの使い方

準備: APIキーに権限を付与する

POST PUT PATCH リクエストを行うためには、APIキーに権限を付与する必要があります。
管理画面のAPIキー設定より、必要なものにチェックを入れて設定します。

API経由でコンテンツを入稿する

画像フィールドの場合

画像フィールドへの入稿は、microCMSにアップロードしている画像URLを指定します。
例えば thumbnail という画像フィールドに入稿したい場合、リクエストボディは以下になります。

{
    "thumbnail": "https://images.microcms-assets.io/assets/cf1eee5feb7944ef932307149db51750/9cbfffdb9ada4fb9ade0179d2a72d634/cover.jpg"
}

microCMS以外でホスティングされた画像URLや、microCMSの別サービスの画像URLが指定された場合はエラーになります。
ローカルにあるファイルを指定したい場合、先日リリースされた画像のアップロードAPIを利用して画像をアップロードし、そのURLをリクエストボディに含めるようにしてください。

セットした画像を外したい場合は、"" （空文字）をPATCHリクエストします。

複数画像フィールドの場合

複数画像フィールドへの入稿は、microCMSにアップロードしている画像URLを配列で指定します。
例えば banners という複数画像フィールドに入稿したい場合、リクエストボディは以下になります。

{
    "banners": [
        "https://images.microcms-assets.io/assets/cf1eee5feb7944ef932307149db51750/9cbfffdb9ada4fb9ade0179d2a72d634/campaign01.jpg",
        "https://images.microcms-assets.io/assets/cf1eee5feb7944ef932307149db51750/202de6ec015f4bbb94a99aa6ea5d9fe2/campaign02.jpg"
    ]
}

指定するURLはmicroCMSにアップロードされているものである必要があります。
セットした複数画像を空にしたい場合は、[] （空配列）をPATCHリクエストしてください。

ファイルフィールドの場合

ファイルフィールドへの入稿は、microCMSにアップロードしているメディアURLを指定します。
例えば manual というファイルフィールドに入稿したい場合、リクエストボディは以下になります。

{
    "manual": "https://files.microcms-assets.io/assets/cf1eee5feb7944ef932307149db51750/9cbfffdb9ada4fb9ade0179d2a72d634/manual.pdf"
}

指定するURLはmicroCMSにアップロードされているものである必要があります。
セットしたファイルを外したい場合は、"" （空文字）をPATCHリクエストしてください。

おわりに

今回のアップデートで、API経由のコンテンツ入稿にすべてのフィールドが対応しました。
先日リリースした画像アップロードのマネジメントAPIとあわせてお使いいただくことで、より効率的にコンテンツを管理できると思います。ぜひ試してみてください。