外部システム連携機能における連携成否の判定基準と通信仕様について
外部システム連携における通信仕様と成否判定基準(タイムアウト・ステータスコード)
A. 外部システムへのデータ送信において、成否判定は「HTTPステータスコード200番台」で行われます。また、リダイレクト追従や自動再送機能は備わっておらず、機能ごとに決められたタイムアウト値(10秒または60秒)が適用されます。
外部システム側のAPI設計や、連携エラー発生時の原因切り分けにご活用ください。
1. 連携の成否判定基準(HTTPステータスコード)
楽楽販売から外部サーバーへリクエストを送信した際、連携先サーバーから返却されるレスポンスヘッダーのHTTPステータスコードによって成否を判定します。
| 判定結果 | ステータスコード | 説明 |
|---|---|---|
| 成功(正常終了) | 200番台(200 OK、201 Created 等) |
連携処理は正常に完了し、自動処理内の後続パーツもそのまま継続実行されます。 |
| 失敗(エラー) | 200番台以外(3xx, 4xx, 5xx系) |
処理は「失敗」と判定されます。自動処理の場合、エラー発生時点で処理全体が中断(ロールバック)されます。 |
2. リダイレクト(300番台)発生時の挙動
連携先サーバーから「301 Moved Permanently」や「302 Found」などのリダイレクト応答が返却された場合、楽楽販売側でリダイレクト先URLを自動追跡(リダイレクト追従)して再送する機能はございません。
リダイレクト応答が返った時点で処理は「失敗」となりますので、連携先URLにはリダイレクトを挟まず直接処理を受け付けるエンドポイントを指定してください。
3. タイムアウト時間と再送仕様
| 自動処理の「HTTP送信」パーツ | 10秒で固定 リクエスト送信から10秒以内に200番台のレスポンスが返らない場合はタイムアウトエラーとなります。 |
|---|---|
| DB設定の「システム連携」機能 | 60秒で固定 CSVデータ等の外部連携において、60秒を超過した場合は強制終了となります。 |
| 失敗時の自動再送(リトライ) | なし 通信エラーやタイムアウト時に自動で再送する仕組みはございません。ログを確認の上、画面から手動で再実行するか、次回のスケジュール実行をお待ちください。 |
💡 タイムアウト(10秒)を防ぐための設計ポイント
外部サーバー側で重いバッチ処理や外部APIの多段呼び出しを行う場合、10秒を超過してタイムアウトになりやすくなります。
外部サーバー側では「リクエストを受信したら即座に 200 OK を返却し、実際のデータ処理は非同期(バックグラウンド)で実行する」構成にしていただくことを推奨いたします。
(記事ID:3096)
「API連携オプション」の関連記事一覧
こちらの記事もあわせてご確認ください。
- CSVインポート時のAPIリクエスト数のカウント方法と上限に関する仕様
- 外部システム側でIPアクセス制限を行う場合に「楽楽販売」の送信元IPアドレスを確認・登録する方法
- ユーザー設定画面に「API」項目が表示されない原因と表示させるための設定手順
- Google Apps Script(GAS)からAPI接続を行う際のIPアドレス制限設定について
- API連携における「APIのアクセス制限」設定の仕様と通信の挙動について
- CSVデータインポートAPIで登録・更新できるデータの範囲について
- CSVデータインポートAPIを利用して外部システムからデータを一括更新・登録する手順
- API連携でDBリンク項目や選択肢項目に値を指定してレコードを登録する方法
- 「楽楽販売」とGoogleカレンダー/OutlookカレンダーのAPI連携について