API 使用の上限

API の使用において、2種類の上限値があります。

• Rate Limit
• 同時接続数

Rate Limit {#ratelimit}

Rate Limit とは 1 分間に実行可能な API の呼び出し回数です。
API の呼び出し回数が Rate Limit を超過すると、呼び出しは一時的に制限され、エラーを返します。

適用対象 {#ratelimit-apply-target}

利用プランおよび Scope により、異なる Rate Limit が適用されます。

注意

• Rate Limit は、アプリを登録した LINE WORKS ドメイン に対して、API 単位で適用されます。
• Rate Limit は、ピーク時を想定した Limit 値です。30 分以上連続して API 呼び出しを行う場合は、Limit 値の半分以下を目安に使用してください。
• 復数のサービスをご利用の場合、API または Scope に対して提供される、最も高い制限値が適用されます。

利用可能な Scope は、ご利用のサービスとプランにより異なります。サービスとプランで利用可能な Scope は OAuth Scopes > Scope リスト から確認できます。

一部の API または Scope については、利用サービスにかかわらず、固有の RateLimit が適用されます。

Rate Limit の確認 {#how-to-check-ratelimit}

Rate Limit が適用される API への応答では、Response Header に以下のフィールドが追加され、状況を確認できます。

注意

• ダウンロード URL を取得する API が成功した場合には、リダイレクトを示す HTTP Status Code 302 が返され、Response Header には Rate Limit に関するフィールドは含まれません。対象となる API は ファイルアップロード / ダウンロード をご参考ください。

注意

• レスポンスヘッダーのフィールド名は大文字小文字を区別せずに扱ってください。表記が予告なく変更される可能性があります。
• 参考: https://www.rfc-editor.org/rfc/rfc9110#section-5.1

Rate Limit を超過した場合には {#how-to-handle-ratelimit}

Rate Limit を超過した場合には、以下のエラーが返ります。

{    "code": "TOO_MANY_REQUESTS",    "description": "API rate limit exceeded"}

直後に API を呼び出すことは避け、基準時間がリセットされた後で失敗した API リクエストを再試行してください。Rate Limit は、最長で 1 分経過するとリセットされます。

ユーザー情報などの頻繁に変更されないデータは、キャッシュに保存して再利用することを検討します。 また、必要とするデータが、すでに呼び出した API のレスポンスに含まれていないか確認してください。不必要な API の呼び出しを回避し、API の呼び出し回数を減らせる可能性があります。

同時接続数の制限 {#concurrent-access}

ドメインで利用するすべての API の合計で、最大で５スレッドまで並列して API を呼び出すことができます。それを超える場合には、API の呼び出しに失敗することがあります。

{    "code": "TOO_MANY_REQUESTS",    "description": "Concurrent access fail"}

注意
一部の API では、同時呼び出し数に個別の制限がかけられている場合があります。
同一リソースに対する書き込みリクエスト (POST/PUT/PATCH/DELETE) は同時に行わないでください。