Instalación y Autenticación de AppFolio
Descripción general
Configura la autenticación de la API de AppFolio Stack. AppFolio utiliza HTTP Basic Auth con un ID de cliente y un secreto de cliente, proporcionados a través de su programa de socios Stack. No existe un SDK público de npm; se deben usar llamadas REST directas.
Prerrequisitos
- Cuenta de socio de AppFolio Stack (appfolio.com/stack)
- ID de cliente y secreto de cliente de AppFolio
- Node.js 18+ o Python 3.10+
Instrucciones
Paso 1: Obtener credenciales de API
# Las credenciales de la API de AppFolio Stack provienen del programa de socios
# 1. Solicita en appfolio.com/stack/become-a-partner
# 2. Completa la revisión de integración
# 3. Recibe la URL base emitida por el proveedor y las instrucciones de entrega de credenciales.
# Almacena los valores en el gestor de secretos aprobado. Realiza commit solo de esta plantilla
# no secreta si el desarrollo local requiere una:
cat > .env.example << 'ENVFILE'
APPFOLIO_CLIENT_ID=
APPFOLIO_CLIENT_SECRET=
APPFOLIO_BASE_URL=
ENVFILE
# .env permanece ignorado; complétalo solo a través de un flujo de secretos local aprobado.
Paso 2: Crear cliente de 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 conexión
# Diagnóstico rápido y redactado sin poner Basic Auth en 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"
Endpoints de API
| Recurso | Endpoint | Métodos |
|---|---|---|
| Propiedades | /api/v1/properties | GET |
| Unidades | /api/v1/units | GET |
| Inquilinos | /api/v1/tenants | GET |
| Arrendamientos | /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 |
Salida
- Credenciales emitidas por el proveedor inyectadas a través del límite de secretos aprobado
- Cliente REST en TypeScript con Basic Auth
- Resultado de conectividad redactado para el endpoint de lectura segura aprobado
Ejemplos
Para un primer ensayo de autenticación, inyecta una credencial de prueba y la URL base emitida por el proveedor a través del mecanismo de secretos local, luego realiza una solicitud de solo lectura a una página de propiedad sintética aprobada. Registra solo el código de estado y el veredicto de configuración del cliente; no imprimas el payload de propiedades, el ID de cliente, el secreto ni la ruta completa del host en registros compartidos. Si el contrato, la URL base, el enlace secreto o el resultado de estado no están verificados, detente antes de cualquier flujo de escritura y haz que el propietario de las credenciales corrija la configuración.
Manejo de errores
| Error | Causa | Solución |
|---|---|---|
401 No autorizado | Credenciales inválidas | Verifica el ID de cliente/secreto de AppFolio |
403 Prohibido | No es 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 a appfolio.com |
Recursos
Próximos pasos
Procede a appfolio-hello-world para tu primera consulta de propiedades.