連携ログ
送信内容、受信内容、結果、エラーを追跡できる形で保存します。
連携ログは、決済、外部API、Webhook、LINE通知、公開フォーム連携などで発生した送受信を、あとから調査できる形で残すための機能です。Roundtableでは「どの連携を記録するか」「どこまで本文を残すか」「誰が確認し再実行できるか」を先にそろえると、発注者、実装者、AIに指示する人が同じ前提で障害対応や問い合わせ対応を設計できます。
この機能でできること
外部へ送ったリクエスト、外部から受け取ったpayload、HTTPステータス、処理結果、エラー要約、対象レコード、実行者、再送可否、実行日時を保存できます。成功と失敗を同じ形式で残すことで、連携先からの問い合わせ、決済確認、Webhookの重複受信、API認証エラー、通知失敗を管理画面から追跡できます。
外部連携の結果を、業務データとは別に調査できる状態にします。
対象レコードには軽い連携状態だけを持たせ、詳細な送受信内容やエラー理由はログ側へ分けると、一覧画面を重くせずに障害時の確認材料を残せます。
よくある利用場面
外部APIやWebhookの成否を確認する
予約送信、在庫取得、会員更新、決済結果受信などの処理ごとに、成功、失敗、再送待ち、対象外を確認します。
問い合わせ時に送受信内容を追跡する
連携先から「届いていない」「値が違う」と連絡があったとき、対象ID、送信日時、本文、応答、エラーを見て原因を切り分けます。
失敗した連携を安全に再実行する
同じpayloadを再送するのか、現在の業務データから作り直すのかを選び、重複処理を避けながら復旧します。
プロンプト例
記録対象、保存する項目、マスクする値、対象レコードとのひも付け、検索条件、再送の有無、保存期間をまとめて伝えると、運用で使えるログ画面を設計しやすくなります。
プロンプト
外部API連携の連携ログを追加してください。予約送信、決済結果取得、Webhook受信、通知送信の各処理で、連携種別、対象レコードID、送受信方向、リクエスト要約、レスポンス要約、HTTPステータス、結果、エラー理由、実行日時、再送可否を保存してください。管理画面では連携種別、結果、対象ID、日付範囲で検索できるようにし、失敗ログは詳細確認後に再送できる導線を置いてください。認証情報、secret、アクセストークン、個人情報の全文はログに残さず、必要な値はマスクしてください。
この機能を使うときのポイント
残す範囲を決める送信本文、受信本文、ヘッダー、結果、エラーのうち、調査に必要な項目だけを残します。
秘密情報をマスクするAPIキー、署名、トークン、カード情報、不要な個人情報は保存前に伏せるか、保存対象から外します。
対象レコードと結び付ける予約、注文、会員、請求など、業務側のどのデータに関係するログかを辿れるようにします。
再送条件を明確にする何度でも再送できる処理か、重複を避けるキーが必要か、手動確認を挟むべきかを決めます。
この機能を実装するときのコツ
実装では、連携処理ごとに個別のログ形式を作りすぎず、連携種別、方向、対象テーブル、対象ID、結果、要約、詳細、エラー、再送状態を共通項目として持たせます。本文を全文保存する場合でも、認証ヘッダーや秘密値は保存前に必ず除外し、長いpayloadは詳細表示でだけ確認できるようにします。再送処理では、ログに保存したpayloadをそのまま使うか、対象レコードの現在値から作り直すかを処理種別ごとに分け、再送結果も別ログとして残すと、あとから復旧経緯を追えます。