AppFolio Hello World
概述
通过提供商颁发的已验证客户端配置,开始使用 AppFolio Property Manager API。本技能指导完成房产列表和租户数量的安全首次读取;创建或更新操作仅限在单独批准的合成沙盒工作流中进行。
前提条件
- 具有 API 访问权限的 AppFolio Stack Partner 账户
- 一个由提供商管理的、已确认目标投资组合的基础 URL 和认证客户端;不得使用猜测的主机名或凭据方案
- Node.js 18+ 和 TypeScript
操作说明
步骤 1:配置客户端
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;
}
步骤 2:列出房产
const properties = await appfolioFetch("/properties?page_size=10");
console.log(`找到 ${properties.length} 处房产`);
properties.forEach((p: any) => console.log(` 房产 ID: ${p.id}`));
步骤 3:获取租户详情
const tenants = await appfolioFetch(`/tenants?property_id=${properties[0].id}`);
console.log(`为已批准的测试数据检索到 ${tenants.length} 条租户记录`);
步骤 4:停止写入操作
// 不要为了快速测试而创建工作订单。仅继续使用 appfolio-core-workflow-b 中的合成、幂等工作流。
输出
成功运行证明托管客户端和批准的只读端点正常工作,在本地输出中仅返回房产 ID 和租户记录计数。
示例
对于首次集成检查,配置已验证的沙盒客户端,查询一个已批准的合成房产页面,并确认其状态、房产 ID 和租户数量,而不记录地址、姓名、单元编号或凭据。不要仅仅为了测试访问权限而创建工作订单。如果投资组合合同、只读测试数据或响应授权未经核实,请停止运行,并在尝试任何变更操作之前,使用凭据所有者的预演流程。
错误处理
| 错误 | 原因 | 解决方案 |
|---|---|---|
401 Unauthorized | 无效的 client_id 或密钥 | 验证环境变量中的凭据 |
403 Forbidden | API 作用域未授权 | 检查 Stack Partner 对该端点的权限 |
404 Not Found | 错误的基础 URL 或端点 | 确认您的公司子域名和 API 版本 |
422 Unprocessable | 缺少必填字段 | 验证 property_id 和必需的请求体参数 |
429 Too Many Requests | 超出速率限制 | 添加退避延迟,批量请求 |
资源
下一步
请参阅 appfolio-core-workflow-a 了解完整的房产和租户管理工作流。