CSVデータインポートAPIのリクエストBody形式(仕様)について
「楽楽販売」のCSVデータインポートAPIにおけるHTTPリクエストBodyは「multipart/form-data」形式で送信する必要があります
「楽楽販売」のCSVデータインポートAPI(CSVファイルインポートAPI)を実行する際、HTTPリクエストのBody形式は「multipart/form-data」として構築する必要があります。これは、CSVファイルというバイナリデータと、インポート設定IDなどのパラメータを同時に送信するための標準的なWeb通信規格です。
APIリクエストを送信する際は、以下の構成でBodyを作成してください。
リクエストBodyの構成要素
- importId: 実行するインポート設定のID(文字列)
- file: インポート対象となるCSVファイル(バイナリデータ)
※API連携オプションをご契約いただくことで、外部システム(RPAや自社開発プログラム等)からこの形式でリクエストを送信し、画面操作を介さずにデータの一括更新を自動化することが可能です。
CSVデータインポートAPI実行時の注意点
API連携を実装する際は、以下の仕様上の制限および注意点をご確認ください。
1. 接続元IPアドレスの登録(必須)
APIを実行する際は、送信元となる外部システムのグローバルIPアドレスを「楽楽販売」の管理画面に登録しておく必要があります。
【設定箇所】管理者設定 > セキュリティ設定 > IPアクセス制限に関する設定
※この登録がない場合、トークンが正しくても「403 Forbidden(アクセスが拒否されました)」エラーとなり、処理が実行されません。
2. インポート設定の事前準備
APIでインポートを実行するには、あらかじめ「楽楽販売」の画面上でインポート設定を作成しておく必要があります。
【設定箇所】DB設定 > 機能設定 > インポート一覧
APIリクエスト時には、この画面で作成した「インポート設定ID(importId)」を指定します。また、CSVファイルの列構成と、インポート設定の「項目設定」が一致していることが正常終了の必須条件となります。
3. 処理件数の上限と分割処理
1回のリクエストで送信できるデータ量には上限(スタンダードプラン:2MB、プロプラン:10MB)があります。30万件規模の大量データを連携する場合は、RPAやプログラム側でデータを数万件単位に分割し、ループ処理で複数回に分けてAPIを呼び出す設計を推奨いたします。
関連マニュアル
詳細な仕様の違いや作成手順については、下記記事をご確認ください。
API連携オプション:設定方法
CSVエクスポートやインポートAPIの正式なエンドポイントURL、リクエスト形式の具体例について解説しています。
API連携オプション:設定方法
インポート一覧:インポートの実行
CSVファイルの読み込みルールや、インポート設定の項目紐付け、エラーデータの確認方法について詳しく解説しています。
インポート一覧:インポートの実行
(記事ID:2993)
「API連携オプション」の関連記事一覧
こちらの記事もあわせてご確認ください。
- 外部システムから「楽楽販売」の特定のレコード詳細画面へ直接遷移するURLを取得する方法
- API連携オプション導入による既存のインポート設定やDB設定への影響について
- 「楽楽販売」のファイル項目(PDF)をAPIで登録する方法と上限サイズについて
- HTTP送信パーツで設定できるデータ構造(ネスト)の制限
- 「レコード登録API」経由の登録で「登録後の自動処理」を実行させることは可能か
- CSVエクスポートAPIでデータ件数が10,000件以内か(事前に何件あるか)を把握する方法
- CSVエクスポートAPIで10,000件を超えるレコードを取得したい
- HTTP送信機能でREST APIのURLにレコードの項目値を動的に埋め込んで送信する方法・設定手順
- API連携でレコードを作成した際に入力画面自動処理を自動実行する方法・設定手順