AppFolio 安裝與認證
概覽
配置 AppFolio Stack API 認證。AppFolio 使用 HTTP 基本認證,搭配客戶端 ID 和客戶端密碼,透過其 Stack 合作夥伴計劃提供。沒有公開的 npm SDK — 請使用直接的 REST API 呼叫。
先決條件
- AppFolio Stack 合作夥伴帳戶 (appfolio.com/stack)
- 來自 AppFolio 的客戶端 ID 和客戶端密碼
- Node.js 18+ 或 Python 3.10+
步驟說明
步驟 1:取得 API 憑證
# AppFolio Stack API 憑證來自合作夥伴計劃
# 1. 於 appfolio.com/stack/become-a-partner 提出申請
# 2. 完成整合審查
# 3. 接收 client_id 和 client_secret
cat > .env << 'ENVFILE'
APPFOLIO_CLIENT_ID=你的客戶端ID
APPFOLIO_CLIENT_SECRET=你的客戶端密碼
APPFOLIO_BASE_URL=https://你的公司.appfolio.com/api/v1
ENVFILE
chmod 600 .env
echo ".env" >> .gitignore
步驟 2:建立 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(`連線成功!找到 ${response.data.length} 個物業`);
return true;
} catch (error: any) {
console.error(`連線失敗:${error.response?.status} ${error.message}`);
return false;
}
}
get http(): AxiosInstance { return this.api; }
}
export { AppFolioClient };
步驟 3:驗證連線
# 快速 curl 測試
curl -u "${APPFOLIO_CLIENT_ID}:${APPFOLIO_CLIENT_SECRET}" \
"${APPFOLIO_BASE_URL}/properties" | jq '.[0]'
API 端點
| 資源 | 端點 | 方法 |
|---|---|---|
| 物業 | /api/v1/properties | GET |
| 單位 | /api/v1/units | GET |
| 租戶 | /api/v1/tenants | GET |
| 租約 | /api/v1/leases | GET, POST |
| 帳單 | /api/v1/bills | GET, POST |
| 供應商 | /api/v1/vendors | GET |
| 業主 | /api/v1/owners | GET |
| 報表 | /api/v1/reports | GET |
輸出結果
- API 憑證配置在
.env檔案中 - 具備基本認證的 TypeScript REST 客戶端
- 已驗證與 AppFolio API 的連線
錯誤處理
| 錯誤 | 原因 | 解決方案 |
|---|---|---|
401 Unauthorized | 憑證無效 | 從 AppFolio 驗證 client_id/secret |
403 Forbidden | 不是 Stack 合作夥伴 | 完成合作夥伴申請 |
404 Not Found | 錯誤的基礎 URL | 使用 你的公司.appfolio.com 格式 |
| 逾時 | 網路問題 | 檢查防火牆是否允許 HTTPS 連線到 appfolio.com |
資源
下一步
繼續進行 appfolio-hello-world,開始你的第一個物業查詢。