¿Qué hace AppFolio Instalar y Autenticar?
Resumen
Configura la autenticación de la API de AppFolio Stack. AppFolio usa HTTP Basic Auth con un client_id y client_secret, proporcionados a través de su programa de socios Stack. No existe un SDK público de npm; se deben hacer llamadas directas a la REST API.
Prerrequisitos
- Cuenta de socio de AppFolio Stack (appfolio.com/stack)
- Client ID y Client Secret de AppFolio
- Node.js 18+ o Python 3.10+
Instrucciones
Paso 1: Obtener credenciales de la API
# Las credenciales de la API de AppFolio Stack se obtienen del programa de socios
# 1. Solicitar en appfolio.com/stack/become-a-partner
# 2. Completar la revisión de integración
# 3. Recibir client_id y client_secret
cat > .env << 'ENVFILE'
APPFOLIO_CLIENT_ID=tu-client-id
APPFOLIO_CLIENT_SECRET=tu-client-secret
APPFOLIO_BASE_URL=https://tu-empresa.appfolio.com/api/v1
ENVFILE
chmod 600 .env
echo ".env" >> .gitignore
Paso 2: Crear el cliente de la 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(`¡Conectado! Se encontraron ${response.data.length} propiedades`);
return true;
} catch (error: any) {
console.error(`Conexión fallida: ${error.response?.status} ${error.message}`);
return false;
}
}
get http(): AxiosInstance { return this.api; }
}
export { AppFolioClient };
Paso 3: Verificar la conexión
# Prueba rápida con curl
curl -u "${APPFOLIO_CLIENT_ID}:${APPFOLIO_CLIENT_SECRET}" \
"${APPFOLIO_BASE_URL}/properties" | jq '.[0]'
Endpoints de la API
| Recurso | Endpoint | Métodos |
|---|---|---|
| Propiedades | /api/v1/properties | GET |
| Unidades | /api/v1/units | GET |
| Inquilinos | /api/v1/tenants | GET |
| Contratos | /api/v1/leases | GET, POST |
| Facturas | /api/v1/bills | GET, POST |
| Proveedores | /api/v1/vendors | GET |
| Propietarios | /api/v1/owners | GET |
| Informes | /api/v1/reports | GET |
Resultado
- Credenciales de la API configuradas en
.env - Cliente REST en TypeScript con autenticación básica
- Conectividad verificada con la API de AppFolio
Manejo de errores
| Error | Causa | Solución |
|---|---|---|
401 No autorizado | Credenciales inválidas | Verifica client_id/secret en AppFolio |
403 Prohibido | No eres socio de Stack | Completa la solicitud de socio |
404 No encontrado | URL base incorrecta | Usa el formato tu-empresa.appfolio.com |
| Tiempo de espera | Problema de red | Verifica que el firewall permita HTTPS hacia appfolio.com |
Recursos
Próximos pasos
Continúa con appfolio-hello-world para tu primera consulta de propiedades.