AppFolio Hello World
Aperçu
Démarrez avec l'API AppFolio Property Manager grâce à une configuration client vérifiée et délivrée par le fournisseur. Ce guide vous accompagne dans les premières lectures sécurisées d'une liste de propriétés et d'un comptage de locataires ; les opérations de création ou de mise à jour appartiennent uniquement à un workflow sandbox synthétique approuvé séparément.
Prérequis
- Un compte Partenaire Stack AppFolio avec accès à l'API
- Une URL de base et une configuration d'authentification gérées et délivrées par le fournisseur, confirmées pour le portefeuille cible ; n'utilisez pas un nom d'hôte ou un schéma d'identification deviné
- Node.js 18+ et TypeScript
Instructions
Étape 1 : Configurer le client
async function appfolioFetch(path: string) {
const res = await createVerifiedAppFolioClient().get(path);
if (res.status < 200 || res.status >= 300) throw new Error(`AppFolio ${res.status}`);
return res.data;
}
Étape 2 : Lister les propriétés
const properties = await appfolioFetch("/properties?page_size=10");
console.log(`Found ${properties.length} properties`);
properties.forEach((p: any) => console.log(` property ID: ${p.id}`));
Étape 3 : Obtenir les détails des locataires
const tenants = await appfolioFetch(`/tenants?property_id=${properties[0].id}`);
console.log(`Retrieved ${tenants.length} tenant records for the approved fixture`);
Étape 4 : Arrêter avant les écritures
// Ne créez pas un bon de travail comme test de démarrage rapide. Continuez uniquement avec le
// workflow synthétique et idempotent dans appfolio-core-workflow-b.
Résultat
Un exécution réussie prouve que le client géré et un point de terminaison de lecture sécurisé approuvé fonctionnent, en renvoyant uniquement les identifiants des propriétés et un comptage des enregistrements de locataires dans sa sortie locale.
Exemples
Pour une première vérification d'intégration, configurez le client sandbox vérifié, interrogez une page de propriété synthétique approuvée, et confirmez son statut, les identifiants de propriétés et le nombre de locataires sans enregistrer d'adresses, de noms, de numéros d'unités ou d'informations d'identification. Ne créez pas un bon de travail simplement pour tester l'accès. Si le contrat de portefeuille, le fixture de lecture sécurisé ou l'autorisation de réponse n'est pas vérifié, arrêtez l'exécution et utilisez le processus de staging du propriétaire des informations d'identification avant de tenter une mutation.
Gestion des erreurs
| Erreur | Cause | Solution |
|---|---|---|
401 Unauthorized | client_id ou secret invalide | Vérifiez les informations d'identification dans les variables d'environnement |
403 Forbidden | Portée API non accordée | Vérifiez les autorisations Stack Partner pour le point de terminaison |
404 Not Found | URL de base ou point de terminaison incorrect | Confirmez votre sous-domaine d'entreprise et la version de l'API |
422 Unprocessable | Champs obligatoires manquants | Validez property_id et les paramètres obligatoires du corps |
429 Too Many Requests | Limite de débit dépassée | Ajoutez un délai d'attente, regroupez les requêtes |
Ressources
Prochaines étapes
Consultez appfolio-core-workflow-a pour les workflows complets de gestion des propriétés et des locataires.