AppFolio Hello World
Übersicht
Erste Schritte mit der AppFolio Property Manager API über eine verifizierte, vom Anbieter ausgestellte Client-Konfiguration. Dieser Skill führt durch sichere erste Lesevorgänge für eine Immobilienliste und eine Mieteranzahl; Erstellungs- oder Aktualisierungsoperationen gehören ausschließlich in einen separat genehmigten synthetischen Sandbox-Workflow.
Voraussetzungen
- AppFolio Stack Partner-Konto mit API-Zugriff
- Eine verwaltete, vom Anbieter ausgestellte Basis-URL und Authentifizierungsclient, bestätigt für das Zielportfolio; verwenden Sie keinen erratenen Hostnamen oder ein erratenes Credential-Schema
- Node.js 18+ und TypeScript
Anleitung
Schritt 1: Client konfigurieren
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;
}
Schritt 2: Immobilien auflisten
const properties = await appfolioFetch("/properties?page_size=10");
console.log(`Found ${properties.length} properties`);
properties.forEach((p: any) => console.log(` property ID: ${p.id}`));
Schritt 3: Mieterdetails abrufen
const tenants = await appfolioFetch(`/tenants?property_id=${properties[0].id}`);
console.log(`Retrieved ${tenants.length} tenant records for the approved fixture`);
Schritt 4: Vor Schreibvorgängen stoppen
// Erstellen Sie keinen Arbeitsauftrag als Schnellstarttest. Fahren Sie nur mit dem
// synthetischen, idempotenten Workflow in appfolio-core-workflow-b fort.
Ausgabe
Ein erfolgreicher Lauf beweist, dass der verwaltete Client und ein genehmigter Safe-Read-Endpunkt funktionieren, und gibt nur Immobilien-IDs und eine Mieteranzahl in seiner lokalen Ausgabe zurück.
Beispiele
Für eine erste Integrationsprüfung konfigurieren Sie den verifizierten Sandbox-Client, fragen Sie eine genehmigte synthetische Immobilienseite ab und bestätigen Sie deren Status, Immobilien-IDs und Mieteranzahl, ohne Adressen, Namen, Einheitennummern oder Anmeldeinformationen aufzuzeichnen. Erstellen Sie keinen Arbeitsauftrag nur, um den Zugriff zu testen. Wenn der Portfoliovertrag, das Safe-Read-Fixture oder die Antwortautorisierung nicht verifiziert sind, stoppen Sie den Lauf und verwenden Sie den Staging-Prozess des Credential-Besitzers, bevor Sie eine Mutation versuchen.
Fehlerbehandlung
| Fehler | Ursache | Lösung |
|---|---|---|
401 Unauthorized | Ungültige client_id oder secret | Überprüfen Sie die Anmeldeinformationen in den Umgebungsvariablen |
403 Forbidden | API-Bereich nicht gewährt | Überprüfen Sie die Stack Partner-Berechtigungen für den Endpunkt |
404 Not Found | Falsche Basis-URL oder Endpunkt | Bestätigen Sie Ihre Firmen-Subdomain und API-Version |
422 Unprocessable | Fehlende erforderliche Felder | Validieren Sie property_id und erforderliche Body-Parameter |
429 Too Many Requests | Ratenlimit überschritten | Fügen Sie Backoff-Verzögerung hinzu, gruppieren Sie Anfragen |
Ressourcen
Nächste Schritte
Siehe appfolio-core-workflow-a für vollständige Workflows zur Immobilien- und Mieterverwaltung.