AppFolio Hello World
概要
検証済みのプロバイダー発行クライアント設定を使用して、AppFolio Property Manager API を使い始めましょう。このスキルでは、物件リストとテナント数を安全に最初に読み取る手順を説明します。作成や更新の操作は、別途承認された合成サンドボックスワークフローにのみ属します。
前提条件
- API アクセス権を持つ AppFolio Stack パートナーアカウント
- 対象ポートフォリオに対して確認済みの、プロバイダー発行のベース 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(`Found ${properties.length} properties`);
properties.forEach((p: any) => console.log(` property ID: ${p.id}`));
ステップ 3: テナントの詳細を取得する
const tenants = await appfolioFetch(`/tenants?property_id=${properties[0].id}`);
console.log(`Retrieved ${tenants.length} tenant records for the approved fixture`);
ステップ 4: 書き込みの前に停止する
// クイックスタートテストとして作業指示を作成しないでください。appfolio-core-workflow-b の合成された冪等なワークフローでのみ続行してください。
出力
正常な実行は、管理されたクライアントと承認された安全な読み取りエンドポイントが機能することを証明し、ローカル出力に物件 ID とテナントレコード数のみを返します。
例
初回統合チェックとして、検証済みのサンドボックスクライアントを設定し、承認された合成物件ページを 1 つクエリし、住所、名前、ユニット番号、認証情報を記録せずに、そのステータス、物件 ID、テナント数を確認します。単にアクセスをテストするために作業指示を作成しないでください。ポートフォリオ契約、安全な読み取りフィクスチャ、または応答認証が検証されていない場合は、実行を停止し、すべての変更を行う前に、認証情報所有者のステージングプロセスを使用してください。
エラーハンドリング
| エラー | 原因 | 解決策 |
|---|---|---|
401 Unauthorized | client_id または secret が無効 | 環境変数で認証情報を確認する |
403 Forbidden | API スコープが付与されていない | エンドポイントの Stack Partner 権限を確認する |
404 Not Found | ベース URL またはエンドポイントが間違っている | 会社のサブドメインと API バージョンを確認する |
422 Unprocessable | 必須フィールドが不足している | property_id と必須の本文パラメータを検証する |
429 Too Many Requests | レート制限を超えた | バックオフ遅延を追加し、リクエストをバッチ処理する |
リソース
次のステップ
完全な物件およびテナント管理ワークフローについては、appfolio-core-workflow-a を参照してください。