Communitygithub.com

AppFolio SDK Patterns

Produktionsreife Muster für die Integration der AppFolio REST-API für Immobilienverwaltung.

Was ist AppFolio SDK Patterns?

Diese Skill bietet eine strukturierte Sammlung produktionsreifer Muster für die Integration der AppFolio REST-API für Immobilienverwaltung. Sie nutzt HTTP Basic Auth mit Client-Anmeldedaten, gibt JSON-Antworten für Immobilien, Mieter, Mietverträge und Arbeitsaufträge zurück und implementiert einen Singleton-Client, um Anmeldedaten-Streuung zu vermeiden, konsistente Fehlerbehandlung zu erzwingen und die Paginierungslogik zu zentralisieren. Die Skill unterstützt Entwickler, die mit Agenten wie Claude Code, Cursor oder Codex arbeiten, indem sie klare Richtlinien für Client-Erstellung, Fehlerbehandlung, Anfrageaufbau und Tests bereitstellt. Ein wesentliches Merkmal ist die explizite Behandlung von Rate-Limits (429) und unbekannten Schreibvorgängen, die auf Aufruferebene entschieden werden müssen, um Datenverluste oder Wettlaufsituationen zu vermeiden.

Funktioniert mit✓Claude Code~Codex CLI✓Cursor
npx skills add https://github.com/jeremylongshore/tons-of-skills-marketplace/tree/HEAD/plugins/saas-packs/appfolio-pack/skills/appfolio-sdk-patterns

In Ihrer bevorzugten KI fragen

Öffnet einen neuen Chat, in dem dieser Agent-Skill bereits geladen ist.

Dokumentation

Was macht AppFolio SDK Patterns?

Übersicht

Produktionsreife Muster für die AppFolio REST-API zur Immobilienverwaltung. AppFolio verwendet HTTP Basic Auth mit Client-Anmeldedaten und gibt JSON-Antworten für Immobilien, Mieter, Mietverträge und Arbeitsaufträge zurück. Ein strukturierter Singleton-Client verhindert die Streuung von Anmeldedaten, erzwingt eine konsistente Fehlerbehandlung und zentralisiert die Paginierungslogik über alle Endpunkte der Immobilienverwaltung.

Voraussetzungen

  • Eine vom Anbieter verifizierte Basis-URL, Authentifizierungsmethode, Endpunkt-Bereich und verwalteter Pfad zur Injektion von Geheimnissen für das Zielportfolio.
  • Schema-Validierung, Anforderungs-Timeout, endpointspezifische Rate-Limits und Idempotenz-Schlüssel für alle änderungsfähigen Dienstmethoden.
  • Synthetische Testdaten für Unit-Tests; Produktionsdaten für Mieter, Mietverträge und Zahlungen dürfen nicht als Standard-Mock-, Log- oder Fehlermeldungsinhalt verwendet werden.

Anleitung

  1. Erstellen Sie einen vertragsgebundenen Client pro Laufzeit und lehnen Sie fehlende oder ungültige Konfiguration ab, bevor Anfragen gestartet werden.
  2. Validieren Sie Abfragegrenzen und Antwortstrukturen an der Dienstgrenze und übergeben Sie nur minimierte, typisierte Felder an die Aufrufer.
  3. Geben Sie einen klassifizierten 429- oder unbekannten Schreibfehler an den Aufrufer zurück; wiederholen Sie nur idempotente Operationen, nachdem der Aufrufer den Cursor/Schlüssel und die Verzögerung aufgezeichnet hat.
  4. Halten Sie Schreib-Workflows hinter expliziten Autorisierungs-, Prüf- und Abgleichskontrollen, anstatt sie in generische SDK-Hilfsprogramme einzubetten.

Singleton-Client

import axios, { AxiosInstance } from 'axios';
let _client: AxiosInstance | null = null;
export function getClient(): AxiosInstance {
  if (!_client) {
    const clientId = process.env.APPFOLIO_CLIENT_ID;
    const clientSecret = process.env.APPFOLIO_CLIENT_SECRET;
    const baseURL = process.env.APPFOLIO_BASE_URL;
    if (!clientId || !clientSecret || !baseURL) throw new Error('APPFOLIO_CLIENT_ID, SECRET, and BASE_URL required');
    _client = axios.create({ baseURL, auth: { username: clientId, password: clientSecret }, timeout: 30000 });
  }
  return _client;
}

Fehler-Wrapper

export class AppFolioError extends Error {
  constructor(public status: number, public code: string, message: string) { super(message); }
}
export async function safeCall<T>(operation: string, fn: () => Promise<T>): Promise<T> {
  try { return await fn(); }
  catch (err: any) {
    const status = err.response?.status ?? 0;
    if (status === 429) {
      const retryAfter = err.response?.headers?.['retry-after'];
      throw new AppFolioError(429, 'RATE_LIMIT', `Wiederholung nach ${retryAfter ?? 'vom Anbieter festgelegter Verzögerung'}; unbekannten Schreibvorgang nicht automatisch wiederholen`);
    }
    if (status === 401) throw new AppFolioError(401, 'AUTH', 'Ungültige APPFOLIO_CLIENT_ID oder SECRET');
    throw new AppFolioError(status, 'API_ERROR', `${operation} fehlgeschlagen [${status}]: ${err.message}`);
  }
}

Anfrage-Builder

class AppFolioQuery {
  private params: Record<string, string> = {};
  status(s: 'active' | 'past' | 'future') { this.params.status = s; return this; }
  propertyId(id: string) { this.params.property_id = id; return this; }
  page(n: number) { this.params.page = String(n); return this; }
  perPage(n: number) { this.params.per_page = String(Math.min(n, 200)); return this; }
  since(date: string) { this.params.updated_since = date; return this; }
  build() { return this.params; }
}
// Verwendung: new AppFolioQuery().status('active').perPage(50).build();

Antworttypen

interface Property {
  id: string; name: string; property_type: 'residential' | 'commercial' | 'mixed';
  address: { street: string; city: string; state: string; zip: string };
  unit_count: number; status: string;
}
interface Tenant {
  id: string; first_name: string; last_name: string;
  email: string; phone: string; unit_id: string; lease_id: string;
}
interface Lease {
  id: string; unit_id: string; tenant_id: string;
  start_date: string; end_date: string; rent_amount: number; status: 'active' | 'expired' | 'future';
}
interface WorkOrder {
  id: string; property_id: string; unit_id: string;
  description: string; priority: 'low' | 'medium' | 'high' | 'emergency';
  status: 'open' | 'in_progress' | 'completed';
}

Test-Hilfsprogramme

export function mockProperty(overrides: Partial<Property> = {}): Property {
  return { id: 'prop-001', name: 'Maple Ridge Apts', property_type: 'residential',
    address: { street: '100 Main St', city: 'Austin', state: 'TX', zip: '78701' },
    unit_count: 24, status: 'active', ...overrides };
}
export function mockLease(overrides: Partial<Lease> = {}): Lease {
  return { id: 'lease-001', unit_id: 'unit-001', tenant_id: 'ten-001',
    start_date: '2025-01-01', end_date: '2026-01-01', rent_amount: 1500, status: 'active', ...overrides };
}

Fehlerbehandlung

MusterVerwendungBeispiel
safeCall-WrapperAlle API-AufrufeVerhindert, dass unbehandelte 4xx/5xx Flows zum Absturz bringen
Aufrufergesteuerte Wiederholung bei 429Ratelimitierte idempotente Batch-LesevorgängeCursor/Schlüssel bewahren, Retry-After beachten, dann bewusst wiederholen
Auth-ValidierungClient-InitialisierungWirft frühzeitig einen Fehler, wenn Anmeldedaten fehlen
PaginierungsschleifeAuflisten von Immobilien/Mieternpage erhöhen, bis leere Antwort

Ausgabe

  • Ein validierter, vertragsgebundener API-Client mit zentralisiertem Timeout und Fehlerklassifizierungsverhalten
  • Begrenzte Abfrageparameter und minimierte typisierte Antworten für Dienstaufrufer
  • Explizite Rate-Limit- und unbekannte Schreibausgaben, die aufrufergesteuerte Cursor-/Idempotenz-/Abgleichsentscheidungen erfordern

Beispiele

Erstellen Sie für einen Lesevorgang einer Immobilienliste eine Abfrage mit einer begrenzten Seitengröße, führen Sie sie durch safeCall aus und überprüfen Sie die zurückgegebenen Immobilien-IDs und die Anzahl anhand eines synthetischen Testdatensatzes. Für eine Mutation persistieren Sie einen Idempotenz-Schlüssel vor dem Absenden und behandeln Sie einen Timeout oder 429 als Pausen-/Abgleichsbedingung, anstatt die Funktion erneut aufzurufen. Wenn Client-Konfiguration, Antwortstruktur oder Schreibergebnis nicht verifiziert sind, stoppen Sie den Workflow und melden Sie einen geschwärzten Fehler an den Eigentümer.

Ressourcen

Nächste Schritte

Wenden Sie die Muster in appfolio-core-workflow-a an.

Individual skills in this repo

This repo contains 20 individual skills — each has its own dedicated page.

jeremylongshore/tons-of-skills-marketplace

Use when asked to structure a landing page for positioning, plan a conversion-optimized page layout, or design a launch page. Examples: "landing page for product launch", "conversion-optimized layout for SaaS

jeremylongshore/tons-of-skills-marketplace

Use when asked to design growth-optimized landing pages, activation funnel layouts, or experiment-friendly page structures. Examples: "growth-optimized landing", "activation funnel layout", "A/B testable page

jeremylongshore/tons-of-skills-marketplace

Use when asked to structure a landing page, design page layout for conversion, or plan landing page information architecture. Examples: "landing page structure for SaaS", "conversion-optimized layout

jeremylongshore/tons-of-skills-marketplace

Generate polished demo videos from a single prompt. Use when the user asks to create a demo video, product walkthrough, feature showcase, or animated presentation. Trigger with "make a demo video", "create a product video", "demo walkthrough", or "feature showcase video".

jeremylongshore/tons-of-skills-marketplace

Track cryptocurrency portfolio with real-time valuations, allocation analysis, and P&L tracking. Use when checking portfolio value, viewing holdings breakdown, analyzing allocations, or exporting portfolio data. Trigger with phrases like "show my portfolio", "check crypto holdings", "portfolio allocation", "track my crypto", or "export portfolio".

jeremylongshore/tons-of-skills-marketplace

Runs the full release workflow for the current project. Commits any uncommitted changes, pushes to remote, creates and merges a PR if on a feature branch, determines the next semver version from conventional commits, creates an annotated git tag and GitHub release with generated notes, cleans up merged branches, and returns to a clean main. Use when the user says promote, ship, release, commit and push, tag and release, or get back to main.

jeremylongshore/tons-of-skills-marketplace

Agent skill at plugins/productivity/content-multiplier/skills/channel-formats/SKILL.md

jeremylongshore/tons-of-skills-marketplace

Operate an evidence-backed editorial queue, balance topic and format coverage, schedule approved drafts, and reconcile backlog state with the publishing system. Use when choosing or scheduling the next blog work. Trigger with "show the editorial calendar" or "pick the next topic".

jeremylongshore/tons-of-skills-marketplace

Configure CI/CD pipeline for AppFolio property management integrations. Trigger: "appfolio CI".

jeremylongshore/tons-of-skills-marketplace

Diagnose and fix common AppFolio API integration errors. Trigger: "appfolio error".

jeremylongshore/tons-of-skills-marketplace

Build property management dashboard with AppFolio API data. Trigger: "appfolio property dashboard".

jeremylongshore/tons-of-skills-marketplace

Automate tenant management and lease operations with AppFolio. Trigger: "appfolio tenant management".

jeremylongshore/tons-of-skills-marketplace

Collect AppFolio API debug evidence for support tickets. Trigger: "appfolio debug".

jeremylongshore/tons-of-skills-marketplace

Deploy AppFolio integration service to cloud infrastructure. Trigger: "deploy appfolio".

jeremylongshore/tons-of-skills-marketplace

Query AppFolio properties, units, and tenants via REST API. Trigger: "appfolio hello world".

jeremylongshore/tons-of-skills-marketplace

Configure AppFolio Stack API authentication with OAuth 2.0. Use when setting up property management API access, registering as an AppFolio Stack partner, or configuring client credentials for API calls. Trigger: "install appfolio", "setup appfolio", "appfolio auth", "appfolio API key".

jeremylongshore/tons-of-skills-marketplace

Set up local development for AppFolio property management API integration. Trigger: "appfolio local dev".

jeremylongshore/tons-of-skills-marketplace

Production readiness checklist for AppFolio integrations. Trigger: "appfolio production checklist".

jeremylongshore/tons-of-skills-marketplace

Handle AppFolio API rate limits with throttling and backoff. Trigger: "appfolio rate limit".

jeremylongshore/tons-of-skills-marketplace

Reference architecture for AppFolio property management integration. Trigger: "appfolio architecture".

Verwandte Skills