操作前の確認
実装前にAPI、認証、権限、ログの責務を切り分けます。
標準手順
画面で再現できる状態を作り、APIレスポンスとログを同じ時刻で突き合わせます。
証跡の残し方
連携失敗時はレスポンス、アクセスログ、監査ログ、外部通知の配送履歴をそろえて調査します。
実際のコンソール導線に合わせて、対象機能、操作ステップ、確認ポイントを画面例で追えるようにしています。
イベント発生、署名付き配送、外部側応答、履歴確認を分けて追跡します。
イベント通知
フォーム送信などのイベントを外部サービスへ通知します。連携先URL、対象イベント、署名確認、再送方針を設定し、テスト送信で外部側が期待する形式を受け取れるか確認します。通知先がCRMやチャット通知の場合は、担当者が確認しやすい項目名にそろえます。
APIだけを見て判断せず、画面の権限ガード、組織コンテキスト、外部通知やログの記録まで含めて確認します。
実装前提、画面/API、ログの3点を同じ時刻で追える形にします。
配送履歴
成功、失敗、レスポンスコード、レスポンス本文、再送状況を確認し、光の道具箱側の設定問題と外部サービス側の受信問題を切り分けます。失敗が続く場合は、発生時刻、対象フォーム、配送ID、外部側ログの4点をそろえて調査します。
APIだけを見て判断せず、画面の権限ガード、組織コンテキスト、外部通知やログの記録まで含めて確認します。
光の道具箱側の設定、外部サービス側の受信、署名検証を順に切り分けます。
セキュリティ
署名検証、HTTPS、最小権限、監査ログ確認を前提に運用します。公開文書には署名シークレットや実URLを載せず、検証方法とローテーション手順だけを説明します。権限変更や通知先変更は監査ログで追える状態にしておきます。
APIだけを見て判断せず、画面の権限ガード、組織コンテキスト、外部通知やログの記録まで含めて確認します。
実装前提、画面/API、ログの3点を同じ時刻で追える形にします。