CSVエクスポートAPIで複数レコードを「一括取得」する方法・仕様

CSVエクスポートAPIは「複数レコードをまとめたCSV形式のデータ」を一括で取得する仕様です

「楽楽販売」のAPI連携機能において、CSVエクスポートAPIは、指定したデータベースのレコード情報を1件ずつ送信するのではなく、複数のレコードをまとめた「CSVデータ」として一括で取得できる仕組みとなっています。

これにより、レコード参照API（1件ずつ取得するAPI）を利用する場合と比較して、通信回数を大幅に削減し、大量のデータを効率的に外部システムへ連携（PULL）することが可能です。

各プランにおけるリクエスト上限とエクスポート制限（1環境あたり）

CSVエクスポートAPIを含む「CSVインポート／エクスポート関連」のAPIグループには、システムの安定稼働を担保するため、ご契約プランごとに以下のリクエスト制限（1環境あたり）が設定されています。
外部システムを開発される際は、以下の閾値を超えないようにリミッター等の流量制御を実装してください。

【容量超過時のエラー制限と分割取得設計】
画面上からの手動CSV出力とは異なり、APIエクスポートでは出力データが上記の上限容量（5MBまたは10MB）を1バイトでも超過した場合、ファイルは自動分割されずに「400エラー（パラメータ不正）」となり処理が失敗します。

上限を超える大量データをエクスポートしたい場合は、一括で取得しようとせず、必ずパラメータの「limit（取得件数）」と「offset（取得開始位置：前回までの取得件数を加算した値）」を使用し、外部システム側で複数回に分割して繰り返しリクエスト（ページネーション）を行って連結するロジックを実装してください。

大量データをAPIで一括取得するための設定手順

外部システムから「楽楽販売」のデータを取得するための、楽楽販売側の事前準備手順です。

手順1：API連携を実行するユーザーの「APIトークン」を発行する

【設定箇所】 管理者設定 ＞ ユーザー設定 ＞ ユーザー管理

1. 「ユーザー管理」の一覧より、API連携に使用するユーザーの「設定」ボタンをクリックします。
2. APIトークン欄の「生成」リンクをクリックし、トークンを発行します。
3. 画面最下部の「確定」ボタンをクリックします。
   ※「確定」を押さないと、生成したトークンがシステム上で有効になりませんので必ずクリックしてください。

※APIトークンに紐づくユーザーが処理の実行者（操作ログ上の実施者）となります。
パスワードの有効期限切れやアカウント削除が発生すると、そのトークンも使用できなくなりますのでご注意ください。

手順2：リクエスト送信元システムのIPアドレスを「APIのアクセス制限」に登録する（重要）

【設定箇所】 管理者設定 ＞ セキュリティ設定 ＞ IPアクセス制限に関する設定

楽楽販売のAPIセキュリティ仕様上、「IPアドレス制限サービス」オプションの契約有無にかかわらず、APIを実行する際はアクセス元（外部システム）のグローバルIPアドレスの登録が100%必須です。
未登録のIPからリクエストを送ると「403 アクセスが拒否されました」となります。

1. 「IPアクセス制限に関する設定」画面を開きます。
2. 「APIのアクセス制限」項目において、連携元システムが通信を送信してくるグローバルIPアドレスを正しく入力し、登録を保存します（可変IPの場合は候補となるアドレスをすべて登録してください）。

※なお、本番操作画面を制御する「ブラウザのアクセス制限」はAPIリクエストには影響しません。必ず「APIのアクセス制限」側に登録を行ってください。

手順3：外部システムからリクエストを送信する

外部システム側から、以下の仕様でリクエストヘッダを構成し、CSVエクスポートAPIのURLに対してリクエストを送信します。HTTPメソッドは「POST」のみ対応しています（GETはエラーとなります）。

• リクエストURL：　
  https://【サーバドメイン】/【アカウント名】/api/csvexport/version/v1
• リクエストヘッダ（認証キー）： X-HD-apitoken: 【手順1で発行したAPIトークン】

※APIトークンを指定する際、Bearer や $、{} などの囲み文字は含めず、確認できるトークン文字列をそのままセットしてください。

関連マニュアル

パラメータの指定方法やレスポンスの詳細については、サクセスナビの下記記事をご確認ください。

「CSVエクスポートAPI」の仕様とパラメータ詳細マニュアル

リクエストパラメータ（dbSchemaId、searchId、listId、limit、offset等）の指定方法、および成功時にJSONではなくCSV形式でデータが返却される固有のレスポンス仕様について解説しています。
API連携：CSVエクスポートAPI

API連携オプション：リクエスト上限や動作条件に関する制限事項

プランごとの1分間のリクエスト回数上限や、上限を超えた場合のエラー挙動（429エラー）、APIのIPアクセス制限（403エラー解決）について詳しく解説しています。
API連携オプション：リクエスト上限について

お問い合わせフォームよりご要望をお寄せください。

「楽楽販売」はお客様から頂戴したご意見・ご要望をもとに、
よりよく、寄り添う 販売管理クラウドを目指してまいります。

現在の仕様ではご希望の機能に対応しておりませんが、
お客様からの貴重なご意見として真摯に受け止め、今後の改善に役立ててまいります。

（記事ID：2909）