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

APIを使って、コンテンツの「公開日時」の入稿や更新ができるようになりました。

公開日時はコンテンツ作成時に自動的にセットされる値ですが、用途にあわせて変更することができます。
これまで変更は管理画面の操作でのみ可能でしたが、今回のアップデートでAPIに対応。ワークフローにあわせてより柔軟にご利用いただけるようになりました。

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

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

APIの使い方

リクエストボディに publishedAt のキーで指定する

POST PUT PATCH リクエストのいずれも、公開日時の指定方法は同じです。
以下の例のように、publishedAt のキーに日時を指定します。

{
    "title": "APIから作成するコンテンツ",
    "content": "公開日時を指定した場合のサンプルです",
    "publishedAt": "2024-01-23T10:00:00Z"  // ★このように指定する
}

日時はISO 8601形式で指定します。フォーマットが不正な場合はエラーになります。
形式があっていれば、過去や未来など用途に応じて任意の日時を指定できます。

細かい注意点

公開日時の指定は「下書き」状態のコンテンツには利用できません。
公開日時はコンテンツ公開時に自動で更新されるため、下書き状態で指定するケースはないと考えているためです。

具体的に、以下の場合は下書きコンテンツに対しての指定と判断されてエラーになります。

• POST PUT のリクエストで、status=draft をクエリパラメータで指定してリクエストする場合
• PATCH のリクエストで、下書き状態のコンテンツにリクエストする場合

ユースケース

API経由での公開日時の入稿・更新について、便利にお使いいただける場面をご紹介します。

他CMSからコンテンツを移行する際、公開日時を引き継ぐ

他のCMSなどからmicroCMSにコンテンツを移行する際、コンテンツの公開日時を引き継いだ形で入稿できます。
これまでは移行したタイミングの日時が公開日時に一度セットされ、管理画面から一つずつ更新する必要があり手間がかかっていました。

publishedAt つきのリクエストをご利用いただくことで、より滑らかに入稿いただけます。

他システムと連携する

例えば自社システムと連携してコンテンツを管理している場合、何かの操作をトリガーにコンテンツの公開日時を更新したい場合があると思います。
API経由で公開日時を操作できるようになったことで、他システムとの連携も組みやすくなっています。

おわりに

今回のアップデートで、API経由でコンテンツの公開日時を操作できるようになりました。
より使いやすいサービスを目指してAPI、管理画面ともに改善してまいります。ご要望などございましたら管理画面右下のチャットボタンよりご意見いただけますと幸いです。