操作前の確認
実装前にAPI、認証、権限、ログの責務を切り分けます。
標準手順
画面で再現できる状態を作り、APIレスポンスとログを同じ時刻で突き合わせます。
証跡の残し方
連携失敗時はレスポンス、アクセスログ、監査ログ、外部通知の配送履歴をそろえて調査します。
実際のコンソール導線に合わせて、対象機能、操作ステップ、確認ポイントを画面例で追えるようにしています。
開発者は、前提条件、画面/API、ログ、外部連携の順に責務を切り分けて確認します。
最初に確認すること
公開API、外部通知、認証、権限の4点を先に確認します。導入時は対象組織、利用アプリ、必要権限、外部連携先、ログ確認者を整理します。APIだけを先に実装すると、後から組織slugや権限不足で詰まりやすいため、画面で同じ操作ができる状態を作ってから連携を進めます。
APIだけを見て判断せず、画面の権限ガード、組織コンテキスト、外部通知やログの記録まで含めて確認します。
実装前提、画面/API、ログの3点を同じ時刻で追える形にします。
画面とAPIの関係
コンソール画面はアドオンごとに分割され、APIは組織コンテキストと権限チェックを前提に動作します。フォーム送信、外部通知の配送、監査ログなどは画面操作とAPIイベントがつながるため、実装時は画面の表示状態、APIレスポンス、ログの3点を同じ時刻で確認します。
APIだけを見て判断せず、画面の権限ガード、組織コンテキスト、外部通知やログの記録まで含めて確認します。
実装前提、画面/API、ログの3点を同じ時刻で追える形にします。
スクリーンショット
公開文書では主要画面のスクリーンショットを併記し、API操作と画面確認を結びつけます。スクリーンショットには秘密情報、個人情報、内部URLを含めず、操作箇所、確認結果、失敗時の戻り先が分かる構図で撮影します。
APIだけを見て判断せず、画面の権限ガード、組織コンテキスト、外部通知やログの記録まで含めて確認します。
実装前提、画面/API、ログの3点を同じ時刻で追える形にします。