CSVエクスポートAPIで10,000件を超えるレコードを取得したい
CSVエクスポートAPIでプランごとの最大件数(または容量上限)を超えるデータを取得するには、外部システム側での分割リクエスト制御(offset・limit)が必要です
「楽楽販売」のCSVエクスポートAPI(csvexport)には、サーバーの安定稼働と負荷防止のため、1回のリクエストで取得できるデータ量に「最大出力件数」および「最大エクスポート容量」の厳格な上限値が設けられています。
対象データベースに蓄積されているデータがこれらの一括出力上限を超える場合、1回のリクエストだけで全件を一括取得することはできません。
外部システム(データ連携プログラムやEAIツールなど)側において、取得開始位置を指定する"offset"パラメータと、取得件数を指定する "limit" パラメータをループ内で動的に加算・制御し、複数回に分割して繰り返しリクエストを送信するプログラム制御を実装していただく必要があります。
関連マニュアル
詳細な仕様の違いや作成手順については、サクセスナビの下記記事をご確認ください。
API連携における各プランのリクエスト上限値と制限回避策
スタンダードプラン(20回/分)とプロプラン(50回/分)で異なる1分間あたりのAPIリクエスト回数上限や、出力可能件数(200件 vs 10,000件)、アップロードファイルサイズ(2MB vs 10MB)などの各種上限仕様をまとめて解説しています。
API連携オプション:リクエスト上限の回避方法
API連携に必要なAPIトークンとPOST送信マニュアル
外部システムから楽楽販売へリクエストする際、認証ヘッダ「X-HD-apitoken」にセットするトークンの発行方法を説明しています(※CSVエクスポートAPIは『POST』メソッドのみ対応しており、GET送信は非対応です。
またトークン前後の$や{}などの記号は一切含めず指定する必要があります)。
API連携オプション:APIトークンの発行方法
【FAQ】CSVエクスポートAPI実行時に容量が超えた場合・結果がない場合の挙動
エクスポートするデータ容量が最大出力容量(5MB/10MB)を超過した際にエラーにはならず、上限サイズまでを正常応答として出力する仕様(サイレントカット)や、対象データが無い(0件)場合に「ヘッダ行のみ」を返却する正常レスポンス仕様を解説しています。
エクスポートできるCSVにサイズ制限はあるか
(記事ID:2936)
「API連携オプション」の関連記事一覧
こちらの記事もあわせてご確認ください。
- HTTP送信機能でREST APIのURLにレコードの項目値を動的に埋め込んで送信する方法・設定手順
- API連携でレコードを作成した際に入力画面自動処理を自動実行する方法・設定手順
- API連携においてOAuth認証を使用することは可能か
- 「楽楽販売」のデータをBtoBプラットフォームにAPI連携で渡し、請求書等を作成・送付する方法
- API連携マニュアル記載の「サンプルプログラム」を入手する方法・手順
- API連携機能で特定の範囲(1〜200件、201件〜など)のデータを取得するためのlimitとoffsetの設定方法
- API経由での操作を「読み取り(参照)専用」に制限する方法はあるか
- APIリクエスト数を確認することはできますか?
- API連携オプション:オプション契約前に検証したい