AppFolio プロダクション・チェックリスト
概要
AppFolio は、不動産運営における物件、テナント、リース、作業指示書を管理します。プロダクション統合では、機密性の高いテナントPII、金融取引、およびメンテナンスワークフローを扱います。障害が発生すると、家賃の未回収、未処理の作業指示書、またはCCPAに基づくテナントデータの漏洩につながる可能性があります。このチェックリストは、AppFolio API統合が耐障害性、準拠性、および監視可能性を備えていることを保証します。
前提条件
- 検証済みのプロダクションパートナー契約、ベースURL、認証メカニズム、許可されたエンドポイントスコープ、およびビジネス、セキュリティ、運用、ロールバック決定のための指名責任者。
- 合成データを使用したサンドボックスリハーサル、個別管理のクレデンシャル、リクエスト予算、記録されたロールバック/調整計画を完了していること。
- 監視可能性、PII最小化、冪等な書き込み、アラートルーティングの証拠(これらのコントロールの存在を単に主張するチェック項目ではありません)。
手順
- プロバイダ発行の実際のクライアント構成をシークレットマネージャーを通じて検証する。リリースコードでエンドポイントや認証スキームをデフォルト設定しない。
- ステージングで準備チェックを実行し、次にプロダクションと同様の環境で、承認された安全な読み取りのみを実行する制御されたリハーサルを実施する。
- 失敗、スキップ、または検証不可能なすべてのコントロールをNo-Goとしてレビューする。クレデンシャル、エンドポイント、監視、復旧に関する編集済みのレシートを保存する。
- テスト済みのロールバックと調整担当者によるプログレッシブリリースのみを許可する。支払い、作業指示書、テナント、またはリースの状態が不明な場合は、書き込みパスを一時停止する。
認証とシークレット
-
APPFOLIO_API_KEYがシークレットマネージャーに保存されている(環境ファイルではない) - クライアントIDとシークレットがアプリケーションコードから分離されている
- キーローテーションスケジュールが文書化されている(90日推奨)
- 開発/ステージング/プロダクション環境ごとに個別のクレデンシャル
- APIクレデンシャルが必要最低限の権限にスコープされている
API統合
- プロダクションベースURLと認証方式が現在のパートナー契約と照合されている
- 指数バックオフによるレート制限処理
- 物件およびテナント一覧エンドポイントのページネーションが実装されている
- 作業指示書作成が必要なすべてのフィールドでテストされている
- リース文書アップロードがサポートされている形式で検証されている
- Webhookエンドポイントがテナントおよび支払いイベント用に設定されている
- 支払いおよび作業指示書作成に冪等性キーが使用されている
エラーハンドリングと耐障害性
- AppFolio API停止に対するサーキットブレーカーが設定されている
- 429/5xx応答に対するリトライとバックオフ
- テナントPII処理がCCPA/FCRAに準拠していることを確認
- 保存前のすべてのAPI応答に対するデータ検証
- 物件同期が利用不可の場合のグレースフルデグラデーション
- 重複作業指示書検出により、リトライ時の再作成を防止
監視とアラート
- エンドポイントごとのAPIレイテンシを追跡(物件、テナント、作業指示書)
- エラー率アラートの設定(しきい値:5分間で3%超)
- 支払い同期の失敗が即座にP1アラートをトリガー
- 作業指示書作成の失敗が5分以内に報告される
- 同期された物件数の日次調整をソースと照合
検証スクリプト
async function checkAppFolioReadiness(): Promise<void> {
const checks: { name: string; pass: boolean; detail: string }[] = [];
const client = createVerifiedAppFolioClient(); // appfolio-security-basics からの契約準拠クライアント
// API接続性
try {
const res = await client.get('/properties?limit=1');
checks.push({ name: 'API接続性', pass: res.status >= 200 && res.status < 300, detail: `HTTP ${res.status}` });
} catch (e: any) { checks.push({ name: 'API接続性', pass: false, detail: e.message }); }
// クライアント構築により、管理されたクレデンシャルとプロバイダ契約が利用可能であることを証明
checks.push({ name: '検証済みクライアント構成', pass: true, detail: '管理構成からロード' });
// 作業指示書エンドポイント
try {
const res = await client.get('/work_orders?limit=1');
checks.push({ name: '作業指示書', pass: res.status >= 200 && res.status < 300, detail: `HTTP ${res.status}` });
} catch (e: any) { checks.push({ name: '作業指示書', pass: false, detail: e.message }); }
for (const c of checks) console.log(`[${c.pass ? 'PASS' : 'FAIL'}] ${c.name}: ${c.detail}`);
}
checkAppFolioReadiness();
エラーハンドリング
| チェック項目 | スキップした場合のリスク | 優先度 |
|---|---|---|
| APIキーローテーション | 期限切れキーにより物件同期が停止 | P1 |
| 支払い同期の失敗 | 家賃の未回収 | P1 |
| テナントPIIの露出 | CCPA違反、法的責任 | P1 |
| 作業指示書の重複 | メンテナンスの重複派遣 | P2 |
| レート制限処理 | 大量物件インポート時の429エラー | P3 |
出力
- 検証済みクライアント、安全な読み取りチェック、監視状態、承認者、およびロールバック/調整計画をまとめた編集済みのGo/No-Goレシート
- リリースをブロックする失敗または未検証のコントロールのリスト
- 機密または書き込み可能なパスを、プロダクションと同様のリハーサルで証拠が得られるまでオフにしておく、制限付きリリース判断
例
作業指示書統合リリースの場合、最初に合成ステージングフィクスチャに対してチェックリストを実行し、次に管理されたプロダクションと同様のクライアントを使用して単一の許可された安全な読み取りを実行します。すべての書き込みを無効にした状態で、アラートルート、PII編集、および冪等性/調整コントロールを確認します。クレデンシャル、エンドポイント契約、準備チェック、またはロールバック演習を検証できない場合は、No-Goを宣言し、以前のリビジョンを保持し、指名された担当者が新しいリハーサルの前に修正するようにします。
リソース
次のステップ
テナントデータ保護とアクセス制御については appfolio-security-basics を参照してください。