AppFolio 基本操作 是做什麼的?
概述
透過經過驗證且由服務提供者發放的用戶端設定,開始使用 AppFolio Property Manager API。此技能會引導你安全地進行房產清單與租客人數的首次唯獨讀取;新增或更新操作僅屬於另行核准的合成沙箱工作流程。
先決條件
- AppFolio Stack 合作夥伴帳戶且已啟用 API 存取
- 由提供者管理的目標投資組合基本 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 或 secret 無效 | 確認環境變數中的憑證正確 |
403 Forbidden | API 範圍未授予 | 檢查 Stack Partner 對端點的權限 |
404 Not Found | 錯誤的基本 URL 或端點 | 確認你的公司子網域與 API 版本 |
422 Unprocessable | 缺少必要欄位 | 驗證 property_id 與必要的 body 參數 |
429 Too Many Requests | 超出速率限制 | 加入退避延遲,批次處理請求 |
資源
後續步驟
請參閱 appfolio-core-workflow-a 以取得完整的房產與租客管理工作流程。