AppFolio インストールと認証 は何をしますか?
概要
AppFolio Stack API の認証を構成します。AppFolio は HTTP Basic 認証にクライアント 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=your-client-id
APPFOLIO_CLIENT_SECRET=your-client-secret
APPFOLIO_BASE_URL=https://your-company.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 |
出力
.envに設定された API 認証情報- Basic 認証を使用する TypeScript REST クライアント
- AppFolio API への接続確認完了
エラーハンドリング
| エラー | 原因 | 解決策 |
|---|---|---|
401 Unauthorized | 無効な認証情報 | AppFolio から client_id/secret を確認する |
403 Forbidden | Stack パートナーでない | パートナー申請を完了する |
404 Not Found | 間違ったベース URL | your-company.appfolio.com 形式を使用する |
| タイムアウト | ネットワーク問題 | ファイアウォールで appfolio.com への HTTPS を許可する |
リソース
次のステップ
最初のプロパティクエリのために appfolio-hello-world に進んでください。