AppFolio Hello World
Resumen
Comience con la API de administración de propiedades de AppFolio a través de una configuración de cliente verificada y emitida por el proveedor. Este skill guía a través de lecturas seguras iniciales para una lista de propiedades y un conteo de inquilinos; las operaciones de creación o actualización pertenecen solo a un flujo de trabajo sintético de sandbox aprobado por separado.
Requisitos previos
- Cuenta de socio de AppFolio Stack con acceso a la API
- Una URL base administrada y emitida por el proveedor y un cliente de autenticación confirmados para el portafolio objetivo; no use un nombre de host o esquema de credenciales adivinado
- Node.js 18+ y TypeScript
Instrucciones
Paso 1: Configurar el Cliente
async function appfolioFetch(path: string) {
const res = await createVerifiedAppFolioClient().get(path);
if (res.status < 200 || res.status >= 300) throw new Error(`AppFolio ${res.status}`);
return res.data;
}
Paso 2: Listar Propiedades
const properties = await appfolioFetch("/properties?page_size=10");
console.log(`Se encontraron ${properties.length} propiedades`);
properties.forEach((p: any) => console.log(` ID de propiedad: ${p.id}`));
Paso 3: Obtener Detalles de Inquilinos
const tenants = await appfolioFetch(`/tenants?property_id=${properties[0].id}`);
console.log(`Se recuperaron ${tenants.length} registros de inquilinos para el fixture aprobado`);
Paso 4: Detenerse Antes de Escribir
// No cree una orden de trabajo como prueba de inicio rápido. Continúe solo con el
// flujo de trabajo sintético e idempotente en appfolio-core-workflow-b.
Salida
Una ejecución exitosa demuestra que el cliente administrado y un endpoint de solo lectura aprobado funcionan, devolviendo solo IDs de propiedades y un conteo de registros de inquilinos en su salida local.
Ejemplos
Para una primera verificación de integración, configure el cliente sandbox verificado, consulte una página de propiedades sintética aprobada y confirme su estado, IDs de propiedades y conteo de inquilinos sin registrar direcciones, nombres, números de unidad o credenciales. No cree una orden de trabajo solo para probar el acceso. Si el contrato del portafolio, el fixture de solo lectura o la autorización de respuesta no están verificados, detenga la ejecución y use el proceso de staging del propietario de las credenciales antes de intentar cualquier mutación.
Manejo de Errores
| Error | Causa | Solución |
|---|---|---|
401 No Autorizado | client_id o secreto inválido | Verifique las credenciales en las variables de entorno |
403 Prohibido | Ámbito de API no concedido | Revise los permisos de socio de Stack para el endpoint |
404 No Encontrado | URL base o endpoint incorrecto | Confirme su subdominio de empresa y versión de API |
422 No Procesable | Faltan campos obligatorios | Valide property_id y los parámetros del cuerpo requeridos |
429 Demasiadas Solicitudes | Límite de tasa excedido | Agregue un retardo de espera, procese solicitudes por lotes |
Recursos
Próximos Pasos
Consulte appfolio-core-workflow-a para flujos de trabajo completos de gestión de propiedades e inquilinos.