Was macht AppFolio Install & Auth?
Übersicht
Richten Sie die Authentifizierung für die AppFolio Stack API ein. 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. Sie erhalten client_id und client_secret
cat > .env << 'ENVFILE'
APPFOLIO_CLIENT_ID=Ihre-Client-ID
APPFOLIO_CLIENT_SECRET=Ihr-Client-Secret
APPFOLIO_BASE_URL=https://ihre-firma.appfolio.com/api/v1
ENVFILE
chmod 600 .env
echo ".env" >> .gitignore
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(`Verbunden! ${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
# Schneller curl-Test
curl -u "${APPFOLIO_CLIENT_ID}:${APPFOLIO_CLIENT_SECRET}" \
"${APPFOLIO_BASE_URL}/properties" | jq '.[0]'
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
- API-Anmeldedaten in
.envkonfiguriert - TypeScript-REST-Client mit Basic Auth
- Überprüfte Verbindung zur AppFolio-API
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 die Partneranmeldung ab |
404 Not Found | Falsche Basis-URL | Verwenden Sie das Format ihre-firma.appfolio.com |
| Timeout | 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.