■ 概要
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
以前こちらでご案内していたfreee会計 ファイルボックス(証憑ファイル)のアップロードAPIのrate limitの仕様変更につきまして、事前に告知していた通り5/19に実施致しましたので、再度ご案内致します。
【重要】freee会計 ファイルボックス(証憑ファイル)のアップロードAPI 変更のお知らせ
freee会計 ファイルボックス(証憑ファイル)のアップロードAPIをご利用の開発者の皆さまにおかれましては、変更点をご確認いただき、アプリ改修などの必要な対応をいただきますよう、よろしくお願い申し上げます。
■ 変更内容
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
変更対象API：freee会計 ファイルボックス(証憑ファイル)のアップロード
変更種別：Breaking Change
変更内容：
– 上記エンドポイントの現在の rate limit は以下です。
【変更前】 600リクエスト/分
【変更後】 300リクエスト/分
- rate limitを超過した場合のエラー内容は以下のように変わります。
【変更前】
ステータスコード：400
エラーメッセージ：「ファイルのアップロードに失敗しました。1分間にアップロードできるファイル数の上限(600ファイル)を超えています。」
【変更後】
ステータスコード：400
エラーメッセージ：「ファイルのアップロードに失敗しました。1分間にアップロードできるファイル数の上限(300ファイル)を超えています。」
変更理由：[変更を行う背景・理由]
freee Public APIの可用性及びセキュリティ強化の一環のため
■ 対応方法
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
上記エンドポイントを利用するアプリが以下の2つの仕様を満たすことを推奨します。
- APIの呼び出し回数の制御
変更後のrate limit（300リクエスト/分）を超えないよう、呼び出し回数の調整をお願い致します。API処理時間は1秒程度のため、直列実行の場合は制限を超える可能性は低いですが、並列実行している場合はスレッド数の調整をご検討ください。※1 - エラー発生に備えた制御
以下のいずれかの機能を実装することをご検討ください。- rate limit制限超過時には、適切な間隔を設けた再試行処理
- rate limit制限によりアップロードに失敗した証憑ファイルをユーザーが手動で再アップロードできる機能。※2
※1. 事業所単位でファイルアップロードのrate limit制限を設けているため、直列実行の場合でも複数のユーザーが同時にアップロードをすると制限を超える可能性があります。
※2. 並列実行時にrate limitに達した場合でも、制限前にアップロードされた証憑ファイルは既に登録済みとなっているため、再アップロードは不要です。
■ 変更後のAPI仕様
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
事業所単位で1分間に実行可能なAPIの呼び出し回数が300回までとなります。rate limitの仕様変更のため、エンドポイント及びリクエストの仕様に変更はありません。