メインコンテンツへスキップ
GetQR API はベータ版で、一部のワークスペースでのみご利用いただけます。正式リリースまでに内容が変更される場合があります。
GetQR API は、API キーごとに送信できるリクエスト数を制限しています。1 つの連携が API 全体を遅くしないようにするためです。

制限

制限は 1 分間のスライディングウィンドウで数えられ、すべてのエンドポイントを合わせて適用されます。ヘルスチェック はキーが不要で、カウントもされません。

レート制限ヘッダー

有効な API キーを使ったリクエストへのレスポンスには、エラーレスポンスも含めて次のヘッダーが付きます。

制限を超えた場合

制限を超えると、API は rate_limit_exceeded コードと同じヘッダーを付けて 429 を返します。
リセット時刻まで待ってから、次のリクエストを送ってください。複数のワーカーが同時に再試行しないようにジッターを加え、5xx エラーでは指数バックオフを使います。
POST /api/v1/qrs を再試行するのは、Idempotency-Key ヘッダーを付けた場合だけにしてください。そうすれば、再試行で 2 つ目の QR コードが作成されることはありません。冪等性 をご覧ください。

制限内に収める

  • X-RateLimit-Remaining を監視し、0 になる前にペースを落とします。
  • QR コードごとに 1 リクエストを送る代わりに、QR コードの一括作成 を使います。
  • pageSize=100 で 1 ページあたり最大 100 件を取得します。ページネーション をご覧ください。
  • QR コードの画像をキャッシュします。ダウンロードは ETag を返すので、If-None-Match を送れば、変更がないときに 304 Not Modified を受け取れます。

次のステップ

エラー

QR コード