平素よりmicroCMSをご利用いただき、誠にありがとうございます。
このたびmicroCMSのサービスに関する仕様変更を予定していますので、ご案内させていただきます。

以下に詳細と必要なご対応についてご案内いたしますので、恐れ入りますがご一読いただきますようお願いいたします。

変更内容

1. コンテンツAPIのlimitパラメータの上限を追加
（新規に作成するサービスのみ）

新規に作成するサービスのコンテンツAPIについて、呼び出しに関する仕様を以下のように変更いたします。

• limitパラメータの上限

無し → 100件

2. マネジメントAPIの呼び出し制限の厳格化

ベータ版機能であるマネジメントAPIについて、呼び出しに関する仕様を以下のように変更いたします。

• limitパラメータの上限

無し → 100件

• 呼び出しのレートリミット

無し → 1 IPアドレスあたり10リクエスト / 10秒

3. 推奨環境からFirefoxを除外

microCMSの推奨環境のブラウザから、Firefoxを除外します。

変更の背景

システムの安定性向上を目的としております。

1. コンテンツAPIのlimitパラメータの上限を追加
（新規に作成するサービスのみ）

コンテンツAPIについては、1回のリクエストでの取得するデータ量が多くなることで、想定以上に負荷が大きくなるケースがあることがありました。そのため、制限を実施させていただくこととなりました。
こちらは、利用中のサービスへの影響を抑えるため、新規に作成するサービスのみを対象としています。また実装の負担を減らすために、JavaScriptのSDKにコンテンツIDの全件取得のメソッドを追加しています。

2. マネジメントAPIの呼び出し制限の厳格化

マネジメントAPIについては、コンテンツAPIとは異なり、ベータ版でのご提供であることや補助的な用途でのリクエストを想定していたため、明示的にリクエストに関する制限をかけておりませんでした。
しかしながら、今後ご利用の用途が拡大していくことを想定しますと、リクエスト数の増加によりシステムの安定提供に影響を及ぼす可能性がございます。
microCMSではなるべくサービスの互換性を維持するように努めておりますが、より安心してご利用いただくため、仕様変更を実施させていただくこととなりました。

3. 推奨環境からFirefoxを除外

多くのブラウザで動作することが理想ではありますが、ブラウザごとの実装の差異による不具合などの問題がありました。
管理画面の安定した動作を実現するため、比較的ご利用シェアの少ないFirefoxを推奨環境から除外させていただくこととなりました。

影響範囲

• 2023年10月2日（月）以降に作成するサービスで、コンテンツAPIを利用する場合
• マネジメントAPIを利用している場合
• ブラウザにFirefoxを利用している場合

変更予定日

2023年10月2日（月）

お客様にて必要となる対応

1. コンテンツAPIのlimitパラメータの上限を追加
（新規に作成するサービスのみ）

• 101件以上のデータを取得する場合は、offsetパラメータを利用し、複数のリクエストに分割してリクエストをお願いします。
• JavaScriptでコンテンツIDの全件取得に利用している場合は、SDKのコンテンツIDの全件取得のメソッドを用いることで、簡単に実装可能です。
• 対象となるAPIは以下の1種類です。

GET /api/v1/{endpoint}

• 並列にリクエストを行う場合、レートリミットに抵触する可能性があります。直列（データ取得完了後に次のリクエストを行う形式）でのリクエストへの変更をお願いします。
• 具体的な実装例については、以下のヘルプをご参照ください

101件以上のコンテンツを取得するにはどうしたらよいですか？

• すでにサービスをご利用中のお客さまには影響ございませんが、可能であれば同様にご対応いただくことを推奨しております。

2. マネジメントAPIの呼び出し制限の厳格化

limitパラメータの上限変更への対応

• 101件以上のデータを取得する場合は、offsetパラメータを利用し、複数のリクエストに分割してリクエストをお願いします。
• 対象となるAPIは以下の2種類です。

GET /api/v1/contents/{endpoint}
GET /api/v1/media

• 並列にリクエストを行う場合、レートリミットに抵触する可能性があります。直列（データ取得完了後に次のリクエストを行う形式）でのリクエストへの変更をお願いします。
• 具体的な実装例については、以下のヘルプをご参照ください

101件以上のコンテンツを取得するにはどうしたらよいですか？

レートリミット上限設定への対応

• 単一のIPアドレスから、10秒間に10件以上のリクエストを行なっている場合は、リクエスト量の調整をお願いします。 
• レートリミットに抵触した際は、ステータスコード：429が返却されます。

3. 推奨環境からFirefoxを除外

• Google Chromeなど、推奨環境のブラウザの利用をお願いします。

今後もより使いやすいサービスになるよう改善を続けてまいります。
ご不明点がございましたら、お気軽にお問合せくださいませ。
引き続き、microCMSをよろしくお願いいたします。

本件に関するお問い合わせ先

microCMSサポート窓口
support@microcms.io