Liste de contrôle de mise en production AppFolio
Présentation
AppFolio gère les propriétés, locataires, baux et ordres de travail pour les opérations immobilières. Une intégration de production traite des données PII sensibles des locataires, des transactions financières et des flux de maintenance. Les défaillances signifient des collectes de loyer manquées, des ordres de travail non traités ou une exposition des données des locataires en vertu du CCPA. Cette liste de contrôle garantit que votre intégration API AppFolio est résiliente, conforme et observable.
Prérequis
- Un contrat partenaire de production vérifié, une URL de base, un mécanisme d'authentification, des périmètres de points de terminaison autorisés, et des responsables nommés pour les décisions commerciales, de sécurité, d'exploitation et de restauration.
- Une répétition en environnement sandbox réalisée avec des données synthétiques, des identifiants gérés séparés, un budget de requêtes et un plan de restauration/réconciliation enregistré.
- Des preuves pour l'observabilité, la minimisation des PII, les écritures idempotentes et le routage des alertes—et non un élément de liste de contrôle qui affirme simplement l'existence de ces contrôles.
Instructions
- Validez la configuration client réelle fournie par l'éditeur via le gestionnaire de secrets ; ne définissez pas de point de terminaison ou de schéma d'authentification par défaut dans le code de version.
- Exécutez les vérifications de préparation en staging, puis une répétition contrôlée en environnement de production qui n'effectue que des lectures sécurisées autorisées.
- Considérez comme non valide tout contrôle échoué, ignoré ou invérifiable ; conservez des reçus expurgés pour les identifiants, points de terminaison, surveillance et reprise.
- Déployez progressivement uniquement avec un responsable de restauration et de réconciliation testé ; mettez en pause les chemins d'écriture si l'état des paiements, des ordres de travail, des locataires ou des baux est inconnu.
Authentification et secrets
-
APPFOLIO_API_KEYstocké dans un gestionnaire de secrets (pas dans les fichiers d'environnement) - ID client et secret séparés du code applicatif
- Calendrier de rotation des clés documenté (recommandé : 90 jours)
- Identifiants distincts pour les environnements dev/staging/prod
- Identifiants API limités aux autorisations minimales requises
Intégration API
- URL de base de production et méthode d'authentification vérifiées par rapport au contrat partenaire actuel
- Gestion des limites de débit avec backoff exponentiel
- Pagination implémentée pour les points de terminaison de listes de propriétés et de locataires
- Création d'ordres de travail testée avec tous les champs obligatoires
- Téléchargement de documents de bail validé pour les formats pris en charge
- Points de terminaison Webhook configurés pour les événements de locataires et de paiements
- Clés d'idempotence utilisées pour la création de paiements et d'ordres de travail
Gestion des erreurs et résilience
- Coupe-circuit configuré pour les pannes API AppFolio
- Nouvelle tentative avec backoff pour les réponses 429/5xx
- Gestion des PII des locataires vérifiée conforme CCPA/FCRA
- Validation des données sur toutes les réponses API avant stockage
- Dégradation progressive lorsque la synchronisation des propriétés est indisponible
- Détection des ordres de travail en double empêchant la re-création lors d'une nouvelle tentative
Surveillance et alertes
- Latence API suivie par point de terminaison (propriétés, locataires, ordres de travail)
- Alertes de taux d'erreur configurées (seuil : >3 % sur 5 minutes)
- Échec de synchronisation des paiements déclenche une alerte P1 immédiate
- Échecs de création d'ordres de travail signalés dans les 5 minutes
- Réconciliation quotidienne du nombre de propriétés synchronisées par rapport à la source
Script de validation
async function checkAppFolioReadiness(): Promise<void> {
const checks: { name: string; pass: boolean; detail: string }[] = [];
const client = createVerifiedAppFolioClient(); // client lié au contrat de appfolio-security-basics
// Connectivité API
try {
const res = await client.get('/properties?limit=1');
checks.push({ name: 'Connectivité API', pass: res.status >= 200 && res.status < 300, detail: `HTTP ${res.status}` });
} catch (e: any) { checks.push({ name: 'Connectivité API', pass: false, detail: e.message }); }
// La construction du client prouve que l'identifiant géré et le contrat fournisseur sont disponibles.
checks.push({ name: 'Configuration client vérifiée', pass: true, detail: 'Chargée depuis la configuration gérée' });
// Point de terminaison des ordres de travail
try {
const res = await client.get('/work_orders?limit=1');
checks.push({ name: 'Ordres de travail', pass: res.status >= 200 && res.status < 300, detail: `HTTP ${res.status}` });
} catch (e: any) { checks.push({ name: 'Ordres de travail', pass: false, detail: e.message }); }
for (const c of checks) console.log(`[${c.pass ? 'RÉUSSI' : 'ÉCHEC'}] ${c.name}: ${c.detail}`);
}
checkAppFolioReadiness();
Gestion des erreurs
| Vérification | Risque en cas de saut | Priorité |
|---|---|---|
| Rotation de la clé API | Les clés expirées bloquent la synchronisation des propriétés | P1 |
| Échec de synchronisation des paiements | Collectes de loyer manquées | P1 |
| Exposition des PII des locataires | Violation CCPA, responsabilité légale | P1 |
| Duplication des ordres de travail | Envoi de maintenance en double | P2 |
| Gestion des limites de débit | Erreurs 429 lors de l'import en masse de propriétés | P3 |
Résultat
- Un reçu de validation/invalidation expurgé liant le client vérifié, les vérifications de lecture sécurisée, l'état de la surveillance, les approbations des responsables, et le plan de restauration/réconciliation.
- Une liste des contrôles échoués ou non prouvés qui bloque la version jusqu'à correction.
- Une décision de déploiement limitée qui maintient les chemins sensibles ou avec capacité d'écriture désactivés jusqu'à ce que leur répétition en environnement de production ait des preuves.
Exemples
Pour une version d'intégration d'ordre de travail, exécutez d'abord la liste de contrôle sur un fixture de staging synthétique, puis utilisez le client géré en environnement de production pour une seule lecture sécurisée autorisée. Confirmez la route d'alerte, la rédaction des PII et les contrôles d'idempotence/réconciliation tandis que toutes les écritures restent désactivées. Si un identifiant, un contrat de point de terminaison, une vérification de préparation ou un exercice de restauration ne peut pas être vérifié, déclarez non valide, conservez la révision précédente et demandez au responsable désigné de corriger avant une nouvelle répétition.
Ressources
Prochaines étapes
Consultez appfolio-security-basics pour la protection des données des locataires et le contrôle d'accès.