API連携でレコードを作成した際に入力画面自動処理を自動実行する方法・設定手順

「楽楽販売」の「レコード登録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）