レート制限
BoxHero API がチームごとにリクエストレートを制限する仕組みと、待機して再試行する方法を説明します。
すべてのユーザーにとってサービスを安定させるため、BoxHero API ではチームが送信できるリクエスト数を制限しています。
制限はチーム単位
Section titled “制限はチーム単位”同じチームに属するすべての API トークンは、同じ制限を共有します。1 つのチームでトークンを追加で発行しても、制限は引き上げられません。秒単位と分単位の制限は同時に適用され、レスポンスヘッダーには分単位の制限値が示されます。
制限に達した場合
Section titled “制限に達した場合”API は 429 と、type が /errors/too-many-requests のエラーエンベロープを返します。再試行できるタイミングはレスポンスヘッダーで確認できます。
| ヘッダー | 説明 |
|---|---|
Retry-After | 再試行するまでに待機する秒数 |
RateLimit, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset | 現在の制限値、残りのリクエスト数、制限がリセットされるタイミング |
Retry-After の時間だけ待ってから再試行してください。多数のリクエストを連続して送信する場合は、一度にまとめて送らずに分散させてください。
同じ IP アドレスからのリクエストで認証が繰り返し失敗した場合（60 秒間に 30 回を超えた場合）、使用したトークンに関係なく、その IP からの以降のリクエストには 429 が返されます。