Installation et authentification AppFolio
Aperçu
Configurez l'authentification de l'API AppFolio Stack. AppFolio utilise l'authentification Basic HTTP avec un ID client et un secret client, fournis via leur programme partenaire Stack. Aucun SDK npm public n'existe — utilisez des appels REST API directs.
Prérequis
- Compte partenaire AppFolio Stack (appfolio.com/stack)
- ID client et secret client d'AppFolio
- Node.js 18+ ou Python 3.10+
Instructions
Étape 1 : Obtenir les identifiants API
# Les identifiants de l'API AppFolio Stack proviennent du programme partenaire
# 1. Postulez sur appfolio.com/stack/devenir-partenaire
# 2. Terminez la revue d'intégration
# 3. Recevez l'URL de base fournie par le prestataire et les instructions de livraison des identifiants.
# Stockez les valeurs dans le gestionnaire de secrets approuvé. Ne committez que ce modèle non secret
# si le développement local en nécessite un :
cat > .env.example << 'ENVFILE'
APPFOLIO_CLIENT_ID=
APPFOLIO_CLIENT_SECRET=
APPFOLIO_BASE_URL=
ENVFILE
# .env reste ignoré ; ne le remplissez que via un flux de secret local approuvé.
Étape 2 : Créer 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(`Connexion échouée : ${error.response?.status} ${error.message}`);
return false;
}
}
get http(): AxiosInstance { return this.api; }
}
export { AppFolioClient };
Étape 3 : Vérifier la connexion
# Diagnostic rapide et expurgé sans mettre Basic Auth dans argv.
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"
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 fournis par le prestataire injectés via la frontière de secret approuvée
- Client REST TypeScript avec Basic Auth
- Résultat de connectivité expurgé pour le point d'accès en lecture seule approuvé
Exemples
Pour une première répétition d'authentification, injectez un identifiant de bac à sable et l'URL de base fournie par le prestataire via le mécanisme de secret local, puis effectuez une seule requête en lecture seule vers une page de propriété synthétique approuvée. Enregistrez uniquement le code de statut et le verdict de configuration du client ; n'imprimez pas la charge utile de la propriété, l'ID client, le secret ou le chemin d'hôte complet dans les journaux partagés. Si le contrat, l'URL de base, la liaison du secret ou le résultat de statut n'est pas vérifié, arrêtez-vous avant tout workflow d'écriture et demandez au propriétaire de l'identifiant de corriger la configuration.
Gestion des erreurs
| Erreur | Cause | Solution |
|---|---|---|
401 Non autorisé | Identifiants invalides | Vérifiez client_id/secret auprès d'AppFolio |
403 Interdit | Pas un partenaire Stack | Terminez la demande de partenaire |
404 Non trouvé | 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é.