Installation et authentification AppFolio
Vue d'ensemble
Configurez l'authentification de l'API AppFolio Stack. AppFolio utilise l'authentification HTTP Basic avec un client ID et un client secret, fournis via leur programme partenaire Stack. Il n'existe pas de SDK npm public — utilisez des appels REST directs.
Prérequis
- Compte partenaire AppFolio Stack (appfolio.com/stack)
- Client ID et Client Secret d'AppFolio
- Node.js 18+ ou Python 3.10+
Instructions
Étape 1 : Obtenez les identifiants API
# Les identifiants API AppFolio Stack proviennent du programme partenaire
# 1. Postulez à appfolio.com/stack/become-a-partner
# 2. Complétez la révision d'intégration
# 3. Recevez client_id et client_secret
cat > .env << 'ENVFILE'
APPFOLIO_CLIENT_ID=your-client-id
APPFOLIO_CLIENT_SECRET=your-client-secret
APPFOLIO_BASE_URL=https://votre-entreprise.appfolio.com/api/v1
ENVFILE
chmod 600 .env
echo ".env" >> .gitignore
Étape 2 : Créez le client API
// 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(`Connecté ! ${response.data.length} propriétés trouvées`);
return true;
} catch (error: any) {
console.error(`Échec de la connexion : ${error.response?.status} ${error.message}`);
return false;
}
}
get http(): AxiosInstance { return this.api; }
}
export { AppFolioClient };
Étape 3 : Vérifiez la connexion
# Test rapide avec curl
curl -u "${APPFOLIO_CLIENT_ID}:${APPFOLIO_CLIENT_SECRET}" \
"${APPFOLIO_BASE_URL}/properties" | jq '.[0]'
Points d'accès API
| Ressource | Point d'accès | Méthodes |
|---|---|---|
| Propriétés | /api/v1/properties | GET |
| Unités | /api/v1/units | GET |
| Locataires | /api/v1/tenants | GET |
| Baux | /api/v1/leases | GET, POST |
| Factures | /api/v1/bills | GET, POST |
| Fournisseurs | /api/v1/vendors | GET |
| Propriétaires | /api/v1/owners | GET |
| Rapports | /api/v1/reports | GET |
Résultat
- Identifiants API configurés dans
.env - Client REST TypeScript avec authentification Basic
- Connectivité vérifiée à l'API AppFolio
Gestion des erreurs
| Erreur | Cause | Solution |
|---|---|---|
401 Unauthorized | Identifiants invalides | Vérifiez client_id/secret depuis AppFolio |
403 Forbidden | Pas un partenaire Stack | Complétez la demande de partenariat |
404 Not Found | Mauvaise URL de base | Utilisez le format votre-entreprise.appfolio.com |
| Délai d'attente | Problème réseau | Vérifiez que le pare-feu autorise HTTPS vers appfolio.com |
Ressources
Prochaines étapes
Passez à appfolio-hello-world pour votre première requête de propriétés.