API連携オプションのよくある質問

APIトークンは、ユーザ管理より発行が可能です。
生成したAPIトークンをリクエストに設定のうえ連携を実行ください。

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

1. ユーザ一覧より、APIトークンを発行するユーザの「設定」をクリック
   
2. APIトークン欄の「生成」をクリックします。
   
3. 生成されたAPIトークンを確認し「確定」をクリックします。
   

（記事ID：2167）

インポート予約順に処理が実行されます。

【例】
データA → データB → データC という順番でインポートAPIを実行した場合、
インポート処理もデータA → データB → データCの順で実行されます。

インポート処理は複数の処理が同時に実行されるということはなく、
直前の処理が完了してから次の処理が開始されます。

（記事ID：2212）

「楽楽販売」 ⇒ 外部システムへデータ連携を実施した際に、処理済みのレコードに対して
処理の実施有無（フラグなど）を自動で登録することはできません。

別途、実施有無を判断するフラグ項目を作成し自動処理などで値の更新を行ってください。

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

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

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

（記事ID：2188）

「楽楽販売」のAPI連携ではファイルの送受信はできません。

「ファイル」「イメージ」項目のファイルや
「自動生成ファイル」項目のファイルを外部システムに送信したり、
逆に外部システムからファイルを受け取り「楽楽販売」の各項目へ
ファイル登録／更新を行うことはできません。

※CSV形式のデータのみ連携が可能です。
　（CSV出力で出力可能な項目／値のみ）

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

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

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

（記事ID：2267）

API連携オプションでは検証プランをご用意しております。
現在お使いの環境にてお試しでAPI連携オプションをご利用できますので
ご希望の際は下記お問い合わせフォームよりご相談ください。

※検証プランではご利用開始日の翌月1日を課金開始日として自動的に課金が開始されます。

検証後、検証プランの解約をご希望の場合は、
課金開始日の5営業日前までにサポート窓口までご連絡ください。

（記事ID：2069）

スタンダードプランを契約中のお客様は、プロプランへ変更することで
各処理のリクエスト上限やファイルサイズ上限を増やすことが可能です。

プロプランの詳細は下記記事をご覧ください。
・プロプランのご案内

各プランごとのリクエスト上限は以下の通りです。

※1環境あたりの上限となります。
※プロプラン以上のリクエスト上限はございません。

 オプションの詳細については下記の記事をご覧ください。
・API連携オプションのご紹介 

（記事ID：2114）

外部システム ⇒「 楽楽販売」へのAPI連携において、
リクエスト上限を超えるリクエストがあった場合、
上限を超えたリクエストはエラーとなり処理が行われません。

※「楽楽販売」側でリクエストを拒否する形となるため、
　1分経過後に自動で順次実行されるということはございません。

上限を超える場合はリクエスト頻度を調整ください。
なお、各プランごとのリクエスト上限は以下の通りです。
（1環境あたりの上限）

（記事ID：2265）

API連携によるレコード更新が優先されます。

排他制御を設定している場合で、特定のレコードを編集している間に
同じレコードに対してAPI連携でレコード更新が行われると
レコード編集画面で「確定」ボタンをクリックした際に、
設定に応じてエラーメッセージまたは警告メッセージが表示されます。

※排他制御に関する詳細は下記記事をご覧ください。

• 複数ユーザーが同じレコードを同時に編集できないようにする方法
  
  

（記事ID：2204）

API連携オプションにおいて、レスポンスで受け取った結果を用いて、リクエストを投げることはできません。

「楽楽販売」から外部システムへのAPI連携にて、
システム連携（HTTP送信パーツを含む）の結果を利用する機能がないため、
接続時の情報（ワンタイムトークンなど）を使用した
2段階認証での接続やデータ連携は行うことができません。

 オプションの詳細については下記の記事をご覧ください。
・API連携オプションのご紹介 

（記事ID：2088）

リクエスト時間からさかのぼりカウントします。

【例】
18:30:10にレコード登録API（リクエストを1件）を実行した場合
18:29:11から18:30:10のリクエスト数をカウントします。

1. 18:29:11から18:30:10の間に、19リクエストが実行済みの場合
   …　レコード登録APIを実行します。
2. 18:29:11から18:30:10の間に、20リクエストが実行済みの場合
   …　エラーとなります。

回避策

時間を置くなど、1分間のリクエスト数が20回を下回るタイミングで再実行してください。

 （記事ID：2216）

処理がエラーとなり新規登録は行われません。
レコードの新規登録を行う場合は「レコード登録API」をご使用ください。

（記事ID：2222）

インポートされたCSVファイルの内容を「楽楽販売」にて確認することはできません。
※手動による実行も同様です

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

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

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

（記事ID：2199）

API連携にシングルサインオンは影響ありません。

APIトークンを発行するユーザが、シングルサインオン認証済／未認証の
どちらにおいても、API連携は可能です。

 オプションの詳細については下記の記事をご覧ください。
・API連携オプションのご紹介 

（記事ID：2180）

外部システム ⇒ 「楽楽販売」のAPI連携でインポート処理を行った場合、
リクエストにて連携された「APIトークン」に紐づくユーザが処理の実行者となります。

また、APIで実行したインポート処理にて「インポート後に実行する自動処理」を
設定していた場合、自動処理の実行者もインポート処理と同様に「APIトークン」に
紐づくユーザとなります。

 オプションの詳細については下記の記事をご覧ください。
・API連携オプションのご紹介 

（記事ID：2197）

リクエスト数の「1アカウント」とは「1ユーザ」ではなく「1環境」を指します。

（記事ID：2223）

APIリクエスト数の確認可否について

現状の仕様としてAPI実行の上限値に対する現在の利用状況や、 過去に利用されたAPIリクエスト数をユーザー様画面から閲覧・確認する機能はございません。

日時別の詳細なリクエスト数や、上限値との乖離状況を直接ご確認いただくことはできません。あらかじめご了承ください。

API連携のリクエスト上限について

APIリクエスト数 閲覧 確認方法 実行回数 履歴 日時別 時間ごと 上限 乖離 把握 見たい できない

現在の「楽楽販売」の仕様では、BtoBプラットフォーム等の外部システムと直接連携して請求書を作成・送付する専用の標準機能はありません

現在の「楽楽販売」の仕様では、「楽楽明細」や「freee」のように「ボタン」一つで特定のBtoBプラットフォームへデータを転送し、帳票発行から送付までを完結させる専用の標準連携機能はありません。

「楽楽販売」は、お客様の業務に合わせて柔軟にカスタマイズできるシステムであるため、特定の外部サービスに依存しない汎用的なデータ連携機能を組み合わせて運用していただく仕組みです。

そのため、BtoBプラットフォームへデータを渡して請求業務を自動化するためには、お手数をおかけしますが、以下の代替案の中から貴社の運用やBtoBプラットフォーム側の仕様（APIの公開状況など）に合わせた連携方法を別途構築していただく必要があります。

BtoBプラットフォームとデータを連携し、請求業務を効率化するための代替案

標準機能としての用意はありませんが、以下の3つの手段を組み合わせることで、実質的にデータの受け渡しや業務の自動化を実現できる可能性があります。

1. API連携オプションの「http送信パーツ」を活用して外部システムへリクエストを送信する

「API連携オプション」をご契約いただくことで、自動処理のパーツとして「http送信パーツ」が利用可能です。BtoBプラットフォーム側がAPIを公開している場合、このパーツを使用して「楽楽販売」のレコードデータを相手方のシステムへ直接送信（リクエスト）できます。これにより、「ボタン」一つでデータを飛ばし、先方システム側で請求書を生成させるようなフローを構築できる可能性があります。
※連携の可否や具体的な設定値（エンドポイントや認証方法など）については、BtoBプラットフォーム側のAPI仕様書をご確認いただく必要があります。

2. CSVエクスポート機能を活用し、BtoBプラットフォーム側へ一括でデータを取り込む

最も確実で導入コストが低い方法です。「楽楽販売」のレコード一覧画面から、請求に必要なデータをCSV形式でエクスポートし、そのファイルをBtoBプラットフォーム側のインポート機能で取り込みます。手動操作になりますが、一度に大量のデータを正確に受け渡すことができ、システムの制限を受けにくい運用が可能です。
「楽楽販売」に登録されているデータをCSVで出力する方法

3. メールボックスオプションを利用して、メールを介したデータ連携を行う

BtoBプラットフォーム側が「メールによるデータ受信」に対応している場合、自動処理の「メール送信」パーツを使用して、請求データを本文に記載したりCSVファイルを添付したりして送信する方法です。

また、「メールボックスオプション」を併用すれば、外部からの返信や処理結果メールを「楽楽販売」側で受信し、ステータスを自動更新するといった双方向の連携も検討できます。
メールボックスオプション：はじめに

外部システムとの連携可否を事前にテストできる「検証プラン」のご案内

「楽楽販売」では、API連携オプションなどの有償機能を最大1か月間無料でお試しいただける「検証プラン」を用意しております。過去に特定のBtoBプラットフォームとの連携実績として公開できる事例がない場合でも、このプランを利用して貴社にて実際の連携テストを行っていただくことが可能です。

検証プランを利用した構築・テストの手順

1. お問い合わせフォームより、API連携オプション等の「検証プラン」を申し込みます。
2. 利用開始日から最大1か月間、実際の環境で「http送信パーツ」などの設定を試行できます。
3. BtoBプラットフォーム側のテスト環境等と接続し、データの受け渡しが正常に行われるか、エラーが発生しないかを確認します。
※検証の結果、運用が難しいと判断された場合は、課金開始日の5営業日前までにキャンセルのご連絡をいただくことで、費用をかけずに終了できます。

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

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

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

（記事ID：2705）

サポートセンターへお問い合わせいただくことで、API連携の「サンプルプログラム」をご提供可能です

「楽楽販売」のAPI連携オプションをご検討、または構築中のお客様向けに、外部システムとの接続イメージを具体的に把握いただくための「サンプルプログラム」を用意しております。
マニュアルの最終ページに記載されている通り、実際のソースコード（PHP等）を確認することで、リクエストの送り方やレスポンスの受け取り方をより正確に理解し、開発工数を削減することが可能です。

サンプルプログラムの入手手順

サンプルプログラムは、セキュリティ保護および最新版提供の観点から、マニュアル内には直接添付されておりません。以下の手順でサポートセンターへ配布を依頼してください。

【確認・対処手順】

1.  お問い合わせフォームより依頼を送信する
   「楽楽販売」サポートサイトの「お問い合わせフォーム」を開き、お問い合わせ内容に「API連携のサンプルプログラム提供希望」と明記して送信してください。

2.  ダウンロードURLの受領
   サポートセンターにて受付後、担当者よりサンプルプログラムを格納した専用ストレージのダウンロードURLがメールで届きます。

3.  解凍パスワードの受領と確認
   ダウンロードURLの案内メールとは別に、ファイルを解凍するための「パスワード案内メール」が送信されます。受領したパスワードを使用してファイルを解凍し、貴社の開発環境にて内容をご確認ください。

※提供するサンプルプログラムは、あくまで実装の参考例として提供するものであり、お客様の特定の環境での動作を完全に保証するものではありません。実際のシステム組み込みにあたっては、貴社の開発担当者様にて十分な検証を行ってください。

関連マニュアル

API連携の基本的な仕様や、リクエスト・レスポンスの構成については、下記記事をご確認ください。

API連携の全体像と設定手順に関するマニュアル

外部システムから「楽楽販売」へリクエストする場合、および「楽楽販売」から外部システムへリクエストする場合のそれぞれの設定手順書をダウンロードいただけます。
API連携オプション：設定方法

（記事ID：2703）

APIリクエスト時のパラメータ「limit」に取得件数を、「offset」に取得開始位置を指定することで実行可能です。

「楽楽販売」のAPI連携機能（レコード参照APIなど）を利用して大量のデータを取得する際、一度に取得できる件数には上限（最大200件）があります。そのため、全データを取得するには「limit（取得件数）」と「offset（取得開始位置）」という2つのパラメータを組み合わせて、データを分割してリクエストする必要があります。

【設定箇所】 外部システムからのAPIリクエストパラメータ（レコード参照APIなど）

設定手順と具体的な値の指定例

取得したいデータの範囲に合わせて、以下のルールで値をセットしてリクエストを実行してください。

◆1. 1件目から200件のデータを取得する場合

最初のデータから上限いっぱいの200件を取得する設定です。
limit（取得件数）： 200
offset（取得開始件数）： 1

◆2. 201件目からさらに200件のデータを取得する場合

201件目を起点として、次のブロックの200件を取得する設定です。
limit（取得件数）： 200
offset（取得開始件数）： 201

※limitに指定できる最大件数は200です。201以上の数値を指定しても、一度に取得できるのは200件までとなります。
※offsetは「何件目から取得を開始するか」を指します。2回目以降のリクエストでは、「前回取得した最後の件数 + 1」の数値を指定してください。

関連マニュアル

詳細な仕様やAPIの仕様書については、下記記事をご確認ください。

API連携オプションの基本的な設定方法

連携設定の全体像について解説しています。
API連携オプション：設定方法

APIリクエストの上限値に関する仕様

1分間あたりのリクエスト回数制限など、プランごとの上限値について詳しく記載されています。
API連携オプション：リクエスト上限の回避方法

（記事ID：2661）

CSVエクスポートAPIでプランごとの最大件数（または容量上限）を超えるデータを取得するには、外部システム側での分割リクエスト制御（offset・limit）が必要です

「楽楽販売」のCSVエクスポートAPI（csvexport）には、サーバーの安定稼働と負荷防止のため、1回のリクエストで取得できるデータ量に「最大出力件数」および「最大エクスポート容量」の厳格な上限値が設けられています。

対象データベースに蓄積されているデータがこれらの一括出力上限を超える場合、1回のリクエストだけで全件を一括取得することはできません。
外部システム（データ連携プログラムやEAIツールなど）側において、取得開始位置を指定する"offset"パラメータと、取得件数を指定する "limit" パラメータをループ内で動的に加算・制御し、複数回に分割して繰り返しリクエストを送信するプログラム制御を実装していただく必要があります。

関連マニュアル

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

API連携における各プランのリクエスト上限値と制限回避策

スタンダードプラン（20回／分）とプロプラン（50回／分）で異なる1分間あたりのAPIリクエスト回数上限や、出力可能件数（200件 vs 10,000件）、アップロードファイルサイズ（2MB vs 10MB）などの各種上限仕様をまとめて解説しています。
API連携オプション：リクエスト上限の回避方法

API連携に必要なAPIトークンとPOST送信マニュアル

外部システムから楽楽販売へリクエストする際、認証ヘッダ「X-HD-apitoken」にセットするトークンの発行方法を説明しています（※CSVエクスポートAPIは『POST』メソッドのみ対応しており、GET送信は非対応です。
またトークン前後の$や{}などの記号は一切含めず指定する必要があります）。
API連携オプション：APIトークンの発行方法

【FAQ】CSVエクスポートAPI実行時に容量が超えた場合・結果がない場合の挙動

エクスポートするデータ容量が最大出力容量（5MB/10MB）を超過した際にエラーにはならず、上限サイズまでを正常応答として出力する仕様（サイレントカット）や、対象データが無い（0件）場合に「ヘッダ行のみ」を返却する正常レスポンス仕様を解説しています。
エクスポートできるCSVにサイズ制限はあるか

（記事ID：2936）

「楽楽販売」の「レコード登録API」では、入力画面自動処理を直接起動させることはできませんが、代替案で自動化できます

現在の「楽楽販売」の仕様では、入力画面自動処理は「ユーザーが入力画面の「確定」ボタンを直接クリックした際」にのみ動作する仕組みです。
そのため、外部システムから「レコード登録API」を用いてデータを登録した場合には、入力画面自動処理は連動して実行されません。これは、APIによる大量登録時のシステム負荷を適切に管理し、データの正確性を保つための仕組み上の制約です。

API連携で作成したレコードに対して、手動操作を挟まずに自動処理を実行したい場合は、以下の2つの代替案のいずれかをご検討ください。

最適な構築手法の選び方・判断基準

• 登録直後に即座に（数分以内に）処理を走らせたい場合
  ➔ 1. 「CSVデータインポートAPI」を利用する方法が適しています。インポート設定の標準機能を利用して、取り込み完了後に自動処理を予約・実行させることができます。
• 既存の「レコード登録API」の仕組みを変えたくない場合
  ➔ 2. 自動処理の「タイマー実行（一括実行）」を利用する方法が適しています。APIで登録された未処理のレコードを特定し、指定した時間にまとめて処理を走らせることができます。

各手段の詳細と設定手順

1. 「CSVデータインポートAPI」と「インポート後に実行する自動処理」設定を組み合わせる

＜メリット＞
API経由でデータが取り込まれた直後（数分以内）に、指定した自動処理を自動的に予約・実行できます。現場のユーザーが手動でボタンを押す手間を完全に排除できます。
＜デメリット＞
「レコード登録API（単一処理）」ではなく「CSVデータインポートAPI（一括処理）」へのプログラム改修が必要です。

【設定箇所】 データベース設定 ＞ 機能設定 ＞ インポート一覧

【設定手順】
◆1. 自動処理の準備
対象のデータベースに、実行したい内容（例：案件レコードの登録やステータス更新など）を組み込んだ自動処理をあらかじめ作成しておきます。
◆2. インポート設定の作成と紐付け
1. 「インポート一覧」画面にて「新規追加」を行い、API連携用のインポート設定を作成します。
2. 「インポート全体設定」画面にある「インポート後に実行する自動処理」のプルダウンから、手順1で作成した自動処理を選択し、確定します。
◆3. APIリクエストの実行
外部システムから「CSVデータインポートAPI」を呼び出し、手順2で作成したインポート設定のIDを指定してデータを送信します。これにより、インポート完了後に自動処理が連動して起動します。

2. 既存の「レコード登録API」を使いつつ、自動処理の「タイマー起動」で後追い処理する

＜メリット＞
現在利用している「レコード登録API」のプログラム側を修正する必要がありません。深夜などにまとめて処理を行う運用に適しています。
＜デメリット＞
リアルタイムでの実行はできません。最短でも1日1回（深夜1時）の実行となります。

【設定箇所】 データベース設定 ＞ 機能設定 ＞ 自動処理設定

【設定手順】
◆1. 処理対象を特定するための「絞込み設定」を作成
APIで登録された直後のレコード（例：案件IDが空、または特定のステータスが「未処理」など）だけを抽出するための絞込み設定を作成します。
◆2. タイマー実行の設定
1. 実行したい自動処理の「設定」ボタンをクリックし、「自動処理一括実行設定」の「設定」を開きます。
2. 「絞込み設定」にて、手順1で作成した条件を選択します。
3. 「タイマースイッチ」を「ON」にし、起動スケジュール（例：毎日）を設定して確定します。
これにより、APIで登録されたレコードに対して、指定した時刻にシステムが自動で一括処理を実行します。

関連マニュアル

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

インポート完了後に自動で処理を走らせるための全体設定

インポート機能と自動処理を連動させる際の件数上限（最大5,000件）や、実行タイミングの仕様について詳しく解説しています。
インポート一覧：インポート後に実行する自動処理

自動処理を特定のスケジュールで定期実行させる設定手順

タイマー起動の優先度や、実行がスキップされる条件などの詳細な仕様が記載されています。
自動処理設定：一括実行（タイマー起動）

（記事ID：2709）

CSVエクスポートAPIで、リクエスト実行前に対象データの総件数のみを事前に把握することはできません

CSVエクスポートAPIを呼び出す際、その対象となるレコードが全部で何件あるのかという情報を、データ取得とは別に事前に確認する機能はありません。
CSVエクスポートAPIは、1回のリクエストで条件に合致するレコードをまとめて「CSV形式の文字列データ」として取得する仕組みとなっているためです。

また、一度のリクエストで取得できる件数には上限（プロプランで10,000件）があるため、事前に件数が分からない状態では、全データを一度に取得しようとしてエラーが発生する可能性があります。

そのため、10,000件を超える大量データを漏れなく連携するためには、お手数をおかけしますが、外部システム側で「分割取得」のロジックを別途新規に実装していただく必要があります。

API連携の制限事項とマニュアル

APIの実行にあたっては、プランごとにリクエスト数やデータ容量の上限が異なります。詳細な仕様については、下記記事をご確認ください。

API連携におけるリクエスト上限とプランごとの違い

スタンダードプランとプロプランにおける、1分間あたりのリクエスト数や出力件数の上限値について詳しく解説しています。
API連携オプション：リクエスト上限の回避方法

外部システムとのデータ連携設定に関するマニュアル

「楽楽販売」から外部システムへ、または外部システムから「楽楽販売」へリクエストを投げる際の基本的な設定手順書です。
API連携オプション：設定方法

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

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

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

（記事ID：2937）

自動処理の「HTTP送信」パーツは、URL欄への項目値埋め込み（パスパラメータ）は非対応です

「HTTP送信」パーツにて項目の値を送れるのは「リクエストパラメータ」のVALUEのみとなっており、URL欄は、プログラム仕様上「固定値（直接入力された文字列）」しか認識されません。
URLのパスの途中に項目値を動的に差し込むパスパラメータ方式（例：https://example.com/api/v1/orders/###受注番号###）のように記述した場合、###受注番号### という文字列がそのまま可変せずに固定で送信されてしまい、通信エラー（HTTP 404等）になります。

外部システムへ動的なパラメータを渡したい場合は、URLには固定のエンドポイント（例：https://example.com/api/v1/orders）を設定した上で、必ず下部の「リクエストパラメータ」設定画面を用いて、KEYに対応するVALUE列として楽楽販売の項目（例：受注番号）を割り当てるようにパラメータ設計を行ってください。

関連マニュアル

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

API連携オプション：設定方法に関するマニュアル

外部システムから「楽楽販売」へ各種API（POSTメソッド）を投げる際の認証ヘッダ、JSONパラメータの構成規則、および送信可能なURL形式（GETメソッドは非対応等）について解説しています。
API連携オプション：設定方法

【FAQ】API連携オプション：レスポンスで受け取った結果を用いて、リクエストを投げることはできるか

HTTP送信パーツ（またはシステム連携）実行時に、相手先サーバーから返却されるレスポンスデータを楽楽販売側の項目に直接引き戻したり、同一処理内の後続パーツへ変数として再利用したりする機能が無い仕様制限について詳しく解説しています。
レスポンス結果を用いたリクエストの送信可否

（記事ID：2933）

「楽楽販売」のAPI連携機能においてOAuth認証を使用することはできません

現在の「楽楽販売」の仕様では、外部システムから「楽楽販売」へリクエストを行う際の認証方式として、OAuth認証（アクセストークンの認可フローなど）を利用する機能はありません。

「楽楽販売」のAPI連携における認証は、ユーザーごとに発行される固定の「APIトークン」をリクエストヘッダに含める方式のみに対応しています。そのため、外部システムとの連携を構築する際は、OAuth認証ではなくAPIトークン認証を利用していただく必要があります。

※なお、システム設定の「送信メールサーバ設定」においては、GoogleやMicrosoft Exchange Onlineとの連携のためにOAuth認証が利用できますが、これはメール送信機能に限定された仕様であり、データベースのデータを操作するAPI連携とは仕組みが異なりますのでご注意ください。

API連携を安全に構築するための代替案

OAuth認証には対応していませんが、APIトークンの利用とアクセス制限を組み合わせることで、セキュリティを確保したデータ連携が可能です。

ユーザー管理画面より「APIトークン」を発行して認証を行う

OAuth認証の代わりに、特定のユーザーに紐づく「APIトークン」を発行し、それを認証キーとして使用します。APIトークンはユーザーごとに一意の文字列として生成され、リクエストヘッダ（X-HD-apitoken）に設定することで認証が行われます。万が一トークンが漏洩した疑いがある場合は、ユーザー管理画面から即座に再生成して古いトークンを無効化できます。

API連携専用の「IPアクセス制限」を設定して接続元を限定する

APIトークンによる認証に加え、接続元のグローバルIPアドレスを制限することでセキュリティを強化できます。許可された外部システムのサーバーIP以外からのリクエストをシステム側で拒否するよう設定してください。この設定は、API連携オプションを利用するための必須条件です。

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

API連携設定時の注意点とマニュアル

API連携を構築する際は、トークンの発行手順やリクエストの上限値について、下記記事をご確認ください。

APIトークンの発行方法に関するマニュアル

ユーザーごとにAPI連携用のキーを生成し、有効化するための具体的な操作手順が記載されています。
API連携オプション：APIトークンの発行方法

API連携オプションの仕様と制限に関するマニュアル

API連携を利用する際のリクエスト上限（1分間あたりの回数）や、プランごとの仕様の違いについて詳しく解説しています。
API連携オプション：設定方法

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

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

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

（記事ID：2708）

「楽楽販売」のAPI連携において、APIトークンごとに「読み取り専用」などの権限を制限することはできません

現在の「楽楽販売」の仕様では、API連携オプションで使用するAPIトークンに対して、特定の操作（参照のみ許可し、更新や削除を禁止するなど）を個別に制限する機能はありません。

「楽楽販売」のAPIトークンは、そのトークンを発行したユーザーアカウントに設定されている「アクセス権（メニュー参照権限やデータベース権限など）」とは紐づかない仕組みとなっています。
そのため、たとえ画面操作において「レコード登録」や「エクスポート」の権限を持たないユーザーが発行したAPIトークンであっても、API経由であればレコード登録APIやエクスポートAPIを実行することが可能な仕様となっています。

API専用のユーザーを作成して権限を絞り込むといった方法でも、API経由の操作自体を制限することはできないため、外部システムとの連携にあたっては、連携先プログラム側で実行するAPIの種類を制御していただく必要があります。

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

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

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

（記事ID：2532）

「楽楽販売」の「レコード登録API」による登録をトリガーとして「登録後の自動処理」を自動実行させることはできません

現在の「楽楽販売」の仕様では、メニュー設定の「入力画面自動処理設定」にて設定した「登録」確定時の自動処理を、API経由でのデータ登録時に連動して実行させる機能はありません。

また、APIリクエストのパラメータ指定によって、画面操作用の自動処理を強制的に起動させることもできない仕様です。

この機能は、あくまで「楽楽販売」の画面上でユーザーが手動で「確定」ボタンをクリックした際のみをトリガーとして動作するように設計されています。
そのため、外部システムからのAPI連携によって登録されたレコードに対して自動処理を適用するためには、お手数をおかけしますが、APIの種類を変更するか、別途一括実行の設定を行っていただく必要があります。

API経由で登録されたレコードに対して自動処理を連携させる代替案

既存の「レコード登録API」では直接起動できませんが、運用上の手間を軽減し、自動で処理を完遂させるための代替案をご案内いたします。

「CSVデータインポートAPI」を利用し、インポート設定の「インポート後に実行する自動処理」機能を活用して自動実行の仕組みを構築する

「レコード登録API」の代わりに「CSVデータインポートAPI」を利用することで、データの取り込み完了をトリガーに自動処理を予約・実行させることが可能です。
この方法であれば、外部システムからデータを投げた後、ユーザーが「楽楽販売」の画面を操作することなく後続の処理（メール送信や他データベースへの転記など）を自動で開始できます。

【設定手順】
◆1. インポート設定の作成
「データベース設定」 ＞ 「機能設定」 ＞ 「インポート一覧」 にて、API連携用のインポート設定を新規作成します。

◆2. 自動処理の紐付け
作成したインポート設定の「全体設定」タブを開き、「インポート後に実行する自動処理」のプルダウンから、実行したい自動処理を選択して「確定」ボタンをクリックします。

◆3. APIの呼び出し
外部システムから「CSVデータインポートAPI」を呼び出し、対象のインポート設定IDを指定してデータを連携します。
これにより、APIによるデータ取り込みが完了した数分後に、システムが自動的に一括自動処理を開始します。

自動処理の「タイマー起動」を設定し、夜間や一定間隔でAPI登録されたレコードを一括処理する

即時実行が必要ない場合は、タイマー機能を利用してシステム側で定期的に未処理レコードをチェックし、処理を走らせる方法が有効です。

【設定手順】
◆1. 自動処理の作成
「データベース設定」 ＞ 「機能設定」 ＞ 「自動処理設定」 にて、処理内容を定義した自動処理を作成します。

◆2. タイマーの設定
該当の自動処理の「設定」ボタン ＞ 「自動処理一括実行設定」の「設定」ボタンをクリックします。

◆3. スケジュールの指定
「タイマースイッチ」をONにし、起動スケジュール（毎日、毎週など）を設定して「確定」ボタンをクリックします。
この設定により、APIで登録されたレコードを含め、条件に合致するデータをまとめて自動で処理できます。

※インポート連動による自動処理は「一括自動処理」の仕組みを利用するため、1回あたりの処理上限は最大5,000件（明細単位の場合は明細行数が基準）となります。
インポートデータが5,001行以上の場合は自動処理が稼働せず全件実行エラーとなりますので、連携するデータ件数にご注意ください。

API連携と自動処理に関する注意点とマニュアル

API経由での登録は、画面操作とは一部挙動が異なります。詳細な仕様や作成手順については、下記記事をご確認ください。

API連携オプションの具体的な設定方法に関するマニュアル

外部システムから「楽楽販売」へリクエストを投げる際の詳細な仕様書を確認できます。
API連携オプション：設定方法

インポート完了後に自動で処理を走らせる設定に関するマニュアル

インポート機能と自動処理を連動させる際の上限件数や実行タイミングの仕様について解説しています。
インポート一覧：インポート後に実行する自動処理

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

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

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

（記事ID：2962）

ネスト（階層）は2階層まで可能、3階層目以降は不可

送信するデータの中に、データを「入れ子（箱の中に箱を入れる構造）」にできる深さが2段階まで、というシステム上の制限がございます。

データ構造のイメージは以下の通りです。

• 1階層（基本データ）：
  データがそのまま並んでいるシンプルな状態です。
  （例）「会社名：〇〇株式会社」「電話番号：03-xxxx-xxxx」
  
  
• 2階層（入れ子1段階・設定可能）：
  データの中に、別のデータグループが1段階入っている状態です。
  （例）「請求書（1階層目）」の中に「複数の明細行（2階層目）」が含まれる構造。
  「楽楽販売」では、明細項目や[複]がついた項目を指定することで設定できます。
  
  
• 3階層以上（入れ子2段階以上・設定不可）：
  入れ子の中に、さらに別の入れ子が含まれる複雑な構造です。
  （例）「請求書（1階層目）」＞「明細行（2階層目）」＞「商品の内訳（3階層目）」のように階層が深くなるデータは、「楽楽販売」の標準機能では設定・送信できません。

Q. 連携先のシステムで3階層以上のデータ形式が求められる場合はどうすればいいですか？

A. 「楽楽販売」単体では対応できないため、以下のいずれかの対応をご検討ください。

1. 中継サーバー（iPaaSやプログラム等）の活用
   「楽楽販売」からはシンプルなデータ（2階層以内）で送信し、中継システム側で3階層以上の形式にデータを整形してから目的のシステムへ転送します。
2. 連携方法・APIの見直し
   連携先システム側で、よりシンプルなデータ構造（2階層以内）で受け取れるAPIや設定項目がないかご確認ください。

（記事ID：2972）