Communitygithub.com

Modèles SDK AppFolio

Appliquez des modèles prêts pour la production pour l'intégration de l'API REST AppFolio.

Qu'est-ce que Modèles SDK AppFolio ?

Ce skill fournit des modèles prêts pour la production pour l'intégration de l'API REST AppFolio de gestion immobilière. Il standardise la création d'un client singleton structuré, la gestion centralisée des erreurs et les boucles de pagination. Le skill prend en charge les langages de programmation courants et les environnements d'exécution via des extraits TypeScript. Il met l'accent sur la validation des entrées, la gestion des limites de débit et la sécurité des opérations d'écriture avec des clés d'idempotence. Les développeurs peuvent ainsi implémenter rapidement des flux de travail fiables pour les propriétés, les locataires, les baux et les ordres de travail, tout en évitant les pièges courants comme la fuite des secrets ou les erreurs non gérées.

Compatible avec✓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

Demander à votre IA préférée

Ouvre une nouvelle conversation avec cette compétence d'agent déjà préchargée.

Documentation

Que fait Modèles SDK AppFolio ?

Aperçu

Modèles prêts pour la production pour l'API REST AppFolio de gestion immobilière. AppFolio utilise l'authentification de base HTTP avec des identifiants client et renvoie des réponses JSON pour les propriétés, les locataires, les baux et les ordres de travail. Un client singleton structuré empêche la prolifération des informations d'identification, applique une gestion cohérente des erreurs et centralise la logique de pagination sur tous les points de terminaison de gestion immobilière.

Prérequis

  • Une URL de base vérifiée par le fournisseur, une méthode d'authentification, une portée de point de terminaison et un chemin d'injection de secret géré pour le portefeuille cible.
  • Validation de schéma, délais d'attente de requête, limites de débit spécifiques aux points de terminaison et clés d'idempotence pour toutes les méthodes de service capables de mutation.
  • Éléments synthétiques pour les tests unitaires ; les charges utiles de production des locataires, des baux et des paiements ne doivent pas devenir le contenu par défaut des mocks, des journaux ou des messages d'erreur.

Instructions

  1. Construisez un client lié par contrat par environnement d'exécution et rejetez les configurations manquantes ou invalides avant le début des requêtes.
  2. Validez les limites de requête et les formes de réponse à la frontière du service, puis transmettez uniquement les champs typés minimisés aux appelants.
  3. Renvoyez un 429 classifié ou un échec d'écriture inconnu à l'appelant ; ne réessayez que les opérations idempotentes après que l'appelant a enregistré le curseur/clé et le délai.
  4. Gardez les flux d'écriture derrière des contrôles d'autorisation, d'audit et de rapprochement explicites plutôt que de les intégrer dans des assistants de commodité SDK génériques.

Client Singleton

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;
}

Gestionnaire d'Erreurs

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', `Retry after ${retryAfter ?? 'provider-directed delay'}; do not replay an unknown write automatically`);
    }
    if (status === 401) throw new AppFolioError(401, 'AUTH', 'Invalid APPFOLIO_CLIENT_ID or SECRET');
    throw new AppFolioError(status, 'API_ERROR', `${operation} failed [${status}]: ${err.message}`);
  }
}

Constructeur de Requêtes

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; }
}
// Utilisation : new AppFolioQuery().status('active').perPage(50).build();

Types de Réponse

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';
}

Utilitaires de Test

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 };
}

Gestion des Erreurs

ModèleQuand l'utiliserExemple
Gestionnaire safeCallTous les appels APIEmpêche les 4xx/5xx non capturés de faire planter les flux
Nouvelle tentative initiée par l'appelant sur 429Lectures par lots idempotentes limitées en débitPréserver le curseur/clé, respecter Retry-After, puis réessayer délibérément
Validation de l'authentificationInitialisation du clientLève une exception tôt si les informations d'identification sont manquantes
Boucle de paginationListe des propriétés/locatairesIncrémenter page jusqu'à réponse vide

Résultat

  • Un client API validé et lié par contrat avec un délai d'attente centralisé et un comportement de classification des erreurs
  • Paramètres de requête limités et réponses typées minimisées pour les appelants de service
  • Résultats explicites de limite de débit et d'écriture inconnue nécessitant des décisions de curseur/idempotence/rapprochement initiées par l'appelant

Exemples

Pour une lecture de liste de propriétés, construisez une requête avec une taille de page plafonnée, exécutez-la via safeCall, et vérifiez les identifiants de propriété retournés et le nombre par rapport à un élément synthétique. Pour une mutation, persistez une clé d'idempotence avant l'envoi et traitez un délai d'attente ou un 429 comme une condition de pause/rapprochement plutôt que d'appeler à nouveau la fonction. Si la configuration du client, le schéma de réponse ou le résultat de l'écriture n'est pas vérifié, arrêtez le flux de travail et signalez une erreur expurgée au propriétaire.

Ressources

Prochaines Étapes

Appliquez les modèles dans appfolio-core-workflow-a.

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".

Skills associés