CSVデータインポートAPIを利用して外部システムからデータを一括更新・登録する手順

「楽楽販売」のCSVデータインポートAPIを利用することで、あらかじめ画面上で定義したインポート設定を呼び出し、外部システムやRPAから送信されたCSVファイルをシステム側で一括処理することが可能です。

画面操作を介さずに、大量のデータを安全かつ効率的に一括更新・登録するための設定手順とAPI送信仕様について解説します。

まずは「楽楽販売」の管理画面にて、データの取り込みルール（CSVの列とDB項目の対応関係）を定義します。

【設定箇所】 DB設定＞機能設定＞インポート一覧

「インポート一覧」画面で「新規追加」をクリックし、インポート設定を作成します。
「全体設定」にて、登録方法（「更新と登録」など）や、明細更新キー（明細キーなど）を指定します。
「項目設定」にて、CSVファイルの列とデータベース項目の紐付け（マッピング）を行います。この設定がAPI実行時のデータ構造の基準となります。
作成完了後、APIリクエスト時に指定する「インポート設定ID（importId）」および「データベースID（dbSchemaId）」を控えておきます。

外部システム（RPAや外部プログラム等）から、以下の仕様でPOSTリクエスト（multipart/form-data形式）を送信します。

【エンドポイントURL】
https://【ドメイン】/【アカウント】/api/csvdataimport/version/v1

認証ヘッダー：
HTTPヘッダーの X-HD-apitoken に、ユーザー管理画面で発行したAPIトークンを指定します。
パラメータ（JSON部）：
手順1で取得した dbSchemaId（データベースID）と importId（インポート設定ID）を指定します。
大量データの分割送信（推奨）：
数十万件規模の大規模データを更新する場合は、APIのタイムアウトや負荷を避けるため、一度に全件を送信せず、RPAやプログラム側でデータを数万件単位に分割し、ループ処理で複数回に分けてAPIを呼び出す設計を推奨します。

API実行後、処理が正常に受け付けられたか、あるいはエラーが発生していないかを管理画面で確認します。

【確認箇所】 DB設定＞状況確認＞インポート状況確認

※万が一エラーが発生した場合は、「インポート状況確認」画面から「エラーデータ.csv」をダウンロードし、エラー原因を特定・修正の上、再インポートを行ってください。

API連携の詳細な仕様やトークンの発行手順につきましては、下記マニュアルをご確認ください。

API連携の接続先URLや、リクエストパラメータの構成規則について詳しく解説しています。
API連携オプション：設定方法

（記事ID：3011）

関連記事