AppFolio Installieren & Authentifizieren
Überblick
Konfigurieren Sie die AppFolio Stack API-Authentifizierung. AppFolio verwendet HTTP Basic Auth mit einer Client-ID und einem Client-Secret, die über das Stack Partnerprogramm bereitgestellt werden. Es gibt kein öffentliches npm SDK – verwenden Sie direkte REST-API-Aufrufe.
Voraussetzungen
- AppFolio Stack Partnerkonto (appfolio.com/stack)
- Client-ID und Client-Secret von AppFolio
- Node.js 18+ oder Python 3.10+
Anleitung
Schritt 1: API-Anmeldedaten abrufen
# AppFolio Stack API-Anmeldedaten stammen aus dem Partnerprogramm
# 1. Bewerben Sie sich unter appfolio.com/stack/become-a-partner
# 2. Schließen Sie die Integrationsprüfung ab
# 3. Erhalten Sie die vom Anbieter ausgegebene Basis-URL und Anweisungen zur Übermittlung der Anmeldedaten.
# Speichern Sie die Werte im genehmigten Secret Manager. Committen Sie nur diese nicht-geheime
# Vorlage, wenn die lokale Entwicklung eine erfordert:
cat > .env.example << 'ENVFILE'
APPFOLIO_CLIENT_ID=
APPFOLIO_CLIENT_SECRET=
APPFOLIO_BASE_URL=
ENVFILE
# .env bleibt ignoriert; befüllen Sie es nur über einen genehmigten lokalen Secret-Flow.
Schritt 2: API-Client erstellen
// src/appfolio-client.ts
import axios, { AxiosInstance } from 'axios';
class AppFolioClient {
private api: AxiosInstance;
constructor() {
this.api = axios.create({
baseURL: process.env.APPFOLIO_BASE_URL,
auth: {
username: process.env.APPFOLIO_CLIENT_ID!,
password: process.env.APPFOLIO_CLIENT_SECRET!,
},
headers: { 'Content-Type': 'application/json' },
timeout: 30000,
});
}
async verifyConnection(): Promise<boolean> {
try {
const response = await this.api.get('/properties');
console.log(`Verbindung hergestellt! ${response.data.length} Immobilien gefunden`);
return true;
} catch (error: any) {
console.error(`Verbindung fehlgeschlagen: ${error.response?.status} ${error.message}`);
return false;
}
}
get http(): AxiosInstance { return this.api; }
}
export { AppFolioClient };
Schritt 3: Verbindung prüfen
# Kurze, bereinigte Diagnose ohne Basic Auth in argv zu setzen.
NETRC_FILE="$(mktemp)"
trap 'rm -f "$NETRC_FILE"' EXIT
chmod 600 "$NETRC_FILE"
APPFOLIO_HOST="${APPFOLIO_BASE_URL#https://}"
APPFOLIO_HOST="${APPFOLIO_HOST%%/*}"
printf 'machine %s login %s password %s\n' "$APPFOLIO_HOST" \
"$APPFOLIO_CLIENT_ID" "$APPFOLIO_CLIENT_SECRET" > "$NETRC_FILE"
curl -s -o /dev/null -w '%{http_code}\n' --netrc-file "$NETRC_FILE" \
"${APPFOLIO_BASE_URL}/properties"
API-Endpunkte
| Ressource | Endpunkt | Methoden |
|---|---|---|
| Immobilien | /api/v1/properties | GET |
| Einheiten | /api/v1/units | GET |
| Mieter | /api/v1/tenants | GET |
| Mietverträge | /api/v1/leases | GET, POST |
| Rechnungen | /api/v1/bills | GET, POST |
| Anbieter | /api/v1/vendors | GET |
| Eigentümer | /api/v1/owners | GET |
| Berichte | /api/v1/reports | GET |
Ausgabe
- Vom Anbieter ausgegebene Anmeldedaten, die über die genehmigte Secret-Grenze injiziert werden
- TypeScript REST-Client mit Basic Auth
- Bereinigtes Konnektivitätsergebnis für den genehmigten Safe-Read-Endpunkt
Beispiele
Für eine erste Authentifizierungsprobe injizieren Sie eine Sandbox-Anmeldedaten und die vom Anbieter ausgegebene Basis-URL über den lokalen Secret-Mechanismus und führen Sie dann eine schreibgeschützte Anfrage an eine genehmigte synthetische Immobilienseite aus. Zeichnen Sie nur den Statuscode und das Client-Konfigurationsurteil auf; geben Sie keine Immobilien-Payload, Client-ID, Secret oder vollständigen Host/Pfad in gemeinsamen Logs aus. Wenn der Vertrag, die Basis-URL, die Secret-Bindung oder das Statusergebnis nicht verifiziert sind, halten Sie vor jedem Schreibworkflow an und lassen Sie den Anmeldedaten-Besitzer die Konfiguration korrigieren.
Fehlerbehandlung
| Fehler | Ursache | Lösung |
|---|---|---|
401 Unauthorized | Ungültige Anmeldedaten | Überprüfen Sie client_id/secret von AppFolio |
403 Forbidden | Kein Stack-Partner | Schließen Sie den Partnerantrag ab |
404 Not Found | Falsche Basis-URL | Verwenden Sie das Format your-company.appfolio.com |
| Zeitüberschreitung | Netzwerkproblem | Prüfen Sie, ob die Firewall HTTPS zu appfolio.com erlaubt |
Ressourcen
Nächste Schritte
Fahren Sie mit appfolio-hello-world für Ihre erste Immobilienabfrage fort.