「楽楽販売」のファイル項目(PDF)をAPIで登録する方法と上限サイズについて
「楽楽販売」のファイル項目へのAPI経由での登録は、2段階のAPI実行により可能です
「楽楽販売」のAPI連携において、ファイル項目(PDF等)を直接レコード登録APIのパラメータに含めて送信することはできません。
ファイルを登録するためには、まず「ファイルアップロードAPI」を使用してファイルをシステムの一時領域へアップロードし、その際に発行される「fileId(ファイルID)」を取得する必要があります。
その後、取得した「fileId」を「CSVデータインポートAPI」のパラメータに指定してレコード登録(または更新)を行うことで、該当のファイル項目へファイルを紐付けることが可能です。
ファイル登録の具体的な処理フロー
外部システム(RPAや自社アプリ等)から以下の手順でAPIを呼び出してください。
1. ファイルアップロードAPIの実行
外部システムからファイルを送信し、一時領域へアップロードします。このリクエストのレスポンスとして、システムから「fileId」が返却されます。
2. CSVデータインポートAPIの実行
手順1で取得した「fileId」を、インポート用CSVデータの該当項目(ファイル項目)の値として指定します。その後、CSVデータインポートAPIを実行することで、レコードの登録・更新と同時にファイルが項目へ格納されます。
ファイル登録時の上限サイズと制限事項
API経由でファイルを登録する際、ご契約プランおよびリクエスト方式によって以下の制限がございます。
- スタンダードプラン: 1リクエストあたり最大2MBまで
- プロプラン: 1リクエストあたり最大10MBまで
※上記上限を超えるファイルを送信しようとすると、APIリクエストが拒否されエラーとなります。上限を超える場合は、ファイルを分割するか、圧縮してサイズを抑えた状態で送信してください。
API連携時の注意点
API経由でのファイル登録は、画面操作とは異なる仕様がございます。
※「ファイル」項目や「イメージ」項目へファイルをアップロードする際、APIリクエストのパラメータ指定や認証(APIトークン)が正しく行われていないと「400 Bad Request」等のエラーが発生します。必ず最新のAPI仕様書をご確認ください。
関連記事
APIの具体的なリクエスト形式や、ファイルアップロードAPIの仕様については、下記記事をご確認ください。
API連携オプション:設定方法
外部システムから「楽楽販売」へリクエストを投げる際の認証ヘッダや、JSONパラメータの構成規則について詳しく解説しています。
API連携オプション:リクエスト上限の回避方法
プランごとのリクエスト上限や、大量データを連携する際の分割処理の考え方について記載されています。
(記事ID:2998)
「API連携オプション」の関連記事一覧
こちらの記事もあわせてご確認ください。
- 外部システムから「楽楽販売」の特定のレコード詳細画面へ直接遷移するURLを取得する方法
- API連携オプション導入による既存のインポート設定やDB設定への影響について
- CSVデータインポートAPIのリクエストBody形式(仕様)について
- HTTP送信パーツで設定できるデータ構造(ネスト)の制限
- 「レコード登録API」経由の登録で「登録後の自動処理」を実行させることは可能か
- CSVエクスポートAPIでデータ件数が10,000件以内か(事前に何件あるか)を把握する方法
- CSVエクスポートAPIで10,000件を超えるレコードを取得したい
- HTTP送信機能でREST APIのURLにレコードの項目値を動的に埋め込んで送信する方法・設定手順
- API連携でレコードを作成した際に入力画面自動処理を自動実行する方法・設定手順