本APIを安定してご利用いただくための利用頻度の目安と、エラー発生時のリトライ設計の考え方をまとめます。
推奨利用頻度
各クライアント(client_id)、各APIエンドポイントごとに 1分間に2000リクエスト以下 でのご利用を推奨します。
超過時の挙動
推奨頻度を超過した場合でも、現状は明示的なエラー(429 等)は返却されません。ただし、これは将来にわたって保証されるものではないため、外部システム側では以下を推奨します。
- 大量データを一括処理する際は、直列(シーケンシャル)でAPIをコールし、並列で大量リクエストを送らない
- 定期バッチ処理などでは、意図的に数十〜数百ミリ秒程度の間隔を空けて呼び出す
- 推奨頻度を恒常的に超える見込みがある場合は、事前に営業担当へご相談ください
タイムアウト
本APIのタイムアウトは 60秒 です。この時間内にレスポンスが得られない場合、外部システム側でリトライまたはエラー処理をおこなってください。
通信要件
| 項目 | 内容 |
|---|---|
| TLSバージョン | TLS 1.2以上(TLS 1.0 / 1.1では接続できません) |
| IPアドレス制限 | なし。アクセス元IPアドレスによる接続制限はおこなっていません |
リトライ設計の推奨パターン
- アクセストークンが有効期限切れ(
401)の場合は、トークンを再取得してから同一リクエストを1回だけリトライする 400 Bad Requestはパラメータ不備が原因のため、リトライしても解消しません。リクエスト内容を見直してください- タイムアウトや一時的なネットワークエラーの場合は、短い間隔をおいて数回までリトライする(無限リトライは避ける)