外部システムからCSVエクスポートAPIを利用してデータ連携を行う方法・設定手順

外部システムから「楽楽販売」のデータを取得するには、CSVエクスポートAPIに対してAPIトークン認証を用いたPOSTリクエストを実行することで設定可能です

「楽楽販売」のAPI連携オプションを利用することで、手動でのCSVエクスポート操作を介さずに、外部システム（基幹システムなど）から直接データを抽出・連携できるようになります。

これにより、バックアップ取得の自動化やシステム間のデータ同期の工数を大幅に削減し、データの正確性を保つことが可能です。

接続に必要なエンドポイントURL・HTTPメソッド・認証方式の仕様

CSVエクスポートAPIを実行するための基本情報は以下の通りです。接続先のURLは、ご利用中の環境ごとに固有のドメイン（サーバー名）とアカウント名（スキーマ名）を含める必要があります。

  • エンドポイントURL：
    https://【ドメイン】/【アカウント】/api/csvexport/version/v1
  • HTTPメソッド： POST
  • 認証方式： APIトークン認証（HTTPヘッダに指定）
  • HTTPヘッダ設定：
    Content-Type: application/json; charset=utf-8
    X-HD-apitoken: [発行したAPIトークン]

外部システムから送信するリクエストパラメータの設定例（JSON形式）と各項目の意味

リクエストのボディには、取得対象のデータベースや抽出条件を特定するためのパラメータをJSON形式で記述します。一度に取得する件数（limit）や開始位置（offset）を指定することで、大量のデータを分割して安全に取得することも可能です。

{
"dbSchemaId": "101406",
"searchId": "100809",
"listId": "100001",
"limit": 200,
"offset": 0
}

【各パラメータの解説】

  • dbSchemaId： 対象データベースのIDです。
  • searchId： 抽出に使用する「絞込み設定」のIDです。
  • listId： 出力形式（列の並び順）を規定する「レコード一覧画面設定」のIDです。※指定しない場合は「ID」の降順かつ、一覧表示が「すべて」の初期項目でエクスポートされます。
  • limit： 一度にエクスポートするレコード件数です（※上限値はプランによって厳格に異なります）。
  • offset： データの取得開始位置（スキップ行数）です。

【APIトークン発行】と【APIアクセス制限（IP登録）】の手順

APIを実行するためには、操作を行うユーザーに紐づく「APIトークン」を事前に発行することに加え、送信元の接続グローバルIPアドレスをシステムに登録しておくことが必要です。

手順1：ユーザー管理画面から「APIトークン」を発行する

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

  1. ユーザー一覧より、APIトークンを発行する対象ユーザー（セキュリティのため、API連携専用ユーザーの作成を強く推奨します）の「設定」ボタンをクリックします。
  2. 「APIトークン」欄にある「生成」リンクをクリックします。
  3. ランダムな文字列（トークン）が生成されるので、内容をコピーして控えておきます。
  4. 画面下部の「確定」ボタンをクリックします。※「確定」を押さないと、生成されたトークンが有効になりませんのでご注意ください。

手順2：APIのアクセス制限（接続元IPアドレス登録）を登録する

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

  1. セキュリティの共通仕様として、「IPアドレス制限サービス」オプションの契約有無にかかわらず、APIを利用する際はアクセス元のグローバルIPアドレス登録が100%必須です。
  2. 「APIのアクセス制限」欄に、リクエストを送信してくる外部システムサーバー等のグローバルIPアドレスを入力し、「確定」をクリックします。未登録のIPからのリクエストは、トークンが正しくてもすべて「403 Forbidden（アクセスが拒否されました）」として強制遮断されます。

URLの構成要素である「ドメイン」と「アカウント」を確認する方法

エンドポイントURLを作成する際に必要となる「ドメイン」と「アカウント」は、普段ログインに使用しているブラウザのURLから確認できます。

【確認例】
ログインURLが https://sv01.rakurakuhanbai.jp/sample_ac/top/main の場合

  • ドメイン： sv01.rakurakuhanbai.jp （サーバー名を含むドメイン）
  • アカウント：  sample_ac （ドメインの直後のスラッシュに続く文字列※ログインIDではありません）

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

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

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

関連マニュアル

詳細な仕様の違いや作成手順については、サクセスナビの下記記事をご確認ください。

API連携の全体的な設定方法と仕様書

外部システムとの連携設定手順書（PDF）をダウンロードできます。
API連携オプション：設定方法

APIトークンの具体的な発行手順

ユーザーごとにAPIトークンを生成・確定して安全に管理・利用する方法について解説しています。
API連携オプション：APIトークンの発行方法

サーバー名やURLアカウント（スキーマ）の確認方法

ご利用中の環境のドメインURLや、アカウント情報（スキーマ名）の確認方法、ログインIDとの違いについて解説しています。
「楽楽販売」の現在のバージョン／サーバー名の確認方法

API連携において1回あたりの上限（200件／10,000件）を超えるデータを連携したい場合

プランごとのエクスポート容量上限（2MB／10MB）やリクエスト数制限（20回／50回）、offsetとlimitパラメータを用いた具体的な分割取得・連結ループプログラムの設計パターンについて詳しく解説しています。
API連携オプション：リクエスト上限の回避方法

（記事ID：2922）