AppFolio インストールと認証
概要
AppFolio Stack API の認証を構成します。AppFolio は HTTP Basic Auth を使用し、Stack パートナープログラムを通じて発行されるクライアントIDとクライアントシークレットが必要です。公開 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. 提供元から発行されたベースURLと資格情報の受け取り手順を受領
# 値を承認済みのシークレットマネージャーに保存してください。ローカル開発用のテンプレートが必要な場合のみ、以下の非機密テンプレートをコミットします:
cat > .env.example << 'ENVFILE'
APPFOLIO_CLIENT_ID=
APPFOLIO_CLIENT_SECRET=
APPFOLIO_BASE_URL=
ENVFILE
# .env は無視されたままになります。承認されたローカルシークレットフローを通じてのみ設定してください。
ステップ 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: 接続の確認
# argv に Basic Auth を載せずに、簡潔かつ編集された診断を実行
NETRC_FILE="$(mktemp)"
trap 'rm -f "$NETRC_FILE"' EXIT
chmod 600 "$NETRC_FILE"
APPFOLIO_HOST="${APPFOLIO_BASE_URL#https://}"
APPFOLIO_HOST="${APPFOLIO_HOST%%/*}"
printf 'machine %s login %s password %s\n' "$APPFOLIO_HOST" \
"$APPFOLIO_CLIENT_ID" "$APPFOLIO_CLIENT_SECRET" > "$NETRC_FILE"
curl -s -o /dev/null -w '%{http_code}\n' --netrc-file "$NETRC_FILE" \
"${APPFOLIO_BASE_URL}/properties"
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 |
出力
- 承認済みのシークレット境界を通じて注入された提供元発行の資格情報
- Basic Auth を使用した TypeScript REST クライアント
- 承認された安全な読み取りエンドポイントへの編集された接続結果
例
初めての認証リハーサルでは、サンドボックス資格情報と提供元発行のベースURLをローカルシークレット機構を通じて注入し、承認された合成物件ページへの読み取り専用リクエストを1回送信してください。ステータスコードとクライアント構成の判定のみを記録し、物件ペイロード、クライアントID、シークレット、完全なホスト/パスを共有ログに出力しないでください。契約、ベースURL、シークレットバインディング、またはステータス結果が未検証の場合は、書き込みワークフロー前に停止し、資格情報の所有者に構成を修正してもらってください。
エラーハンドリング
| エラー | 原因 | 解決策 |
|---|---|---|
401 Unauthorized | 無効な資格情報 | AppFolio からクライアントID/シークレットを確認 |
403 Forbidden | Stack パートナーでない | パートナー申請を完了 |
404 Not Found | ベースURLが間違っている | your-company.appfolio.com 形式を使用 |
| タイムアウト | ネットワークの問題 | ファイアウォールが appfolio.com への HTTPS を許可しているか確認 |
リソース
次のステップ
最初の物件クエリのために appfolio-hello-world に進んでください。