ローカル開発環境の実キャプチャ
操作前の確認
実装前にAPI、認証、権限、ログの責務を切り分けます。
標準手順
画面で再現できる状態を作り、APIレスポンスとログを同じ時刻で突き合わせます。
証跡の残し方
連携失敗時はレスポンス、アクセスログ、監査ログ、外部通知の配送履歴をそろえて調査します。
画面ガイド
実際のコンソール導線に合わせて、対象機能、操作ステップ、確認ポイントを画面例で追えるようにしています。
/docs/developers
ナビゲーション
公開API
アクセスログ
監査ログ
管理基盤
公開API
1
API利用の前提
2
エラー調査
3
運用連携
APIレスポンスだけで判断せず、アクセスログと監査ログまで同じ流れで確認します。
API利用の前提
APIは組織コンテキスト、認証、権限を前提に利用します。用途ごとにアクセス範囲を確認します。
1. API利用の前提 の確認観点
対象組織と権限が揃っていることを確認する
画面操作とAPI呼び出しで同じデータを見ていることを確認する
失敗時にアクセスログまたは監査ログで追跡できることを確認する
APIだけを見て判断せず、画面の権限ガード、組織コンテキスト、外部通知やログの記録まで含めて確認します。
実装前提、画面/API、ログの3点を同じ時刻で追える形にします。
エラー調査
権限不足、バリデーション、外部連携失敗はレスポンスとアクセスログを合わせて確認します。
2. エラー調査 の確認観点
対象組織と権限が揃っていることを確認する
画面操作とAPI呼び出しで同じデータを見ていることを確認する
失敗時にアクセスログまたは監査ログで追跡できることを確認する
APIだけを見て判断せず、画面の権限ガード、組織コンテキスト、外部通知やログの記録まで含めて確認します。
実装前提、画面/API、ログの3点を同じ時刻で追える形にします。
運用連携
API利用状況はアクセスログ、操作変更は監査ログで確認します。
3. 運用連携 の確認観点
対象組織と権限が揃っていることを確認する
画面操作とAPI呼び出しで同じデータを見ていることを確認する
失敗時にアクセスログまたは監査ログで追跡できることを確認する
APIだけを見て判断せず、画面の権限ガード、組織コンテキスト、外部通知やログの記録まで含めて確認します。
実装前提、画面/API、ログの3点を同じ時刻で追える形にします。