AppFolio Hello World
개요
검증된 공급업체 발급 클라이언트 구성을 통해 AppFolio Property Manager API를 시작합니다. 이 스킬은 부동산 목록과 세입자 수에 대한 안전한 첫 번째 읽기 작업을 안내합니다. 생성 또는 업데이트 작업은 별도로 승인된 합성 샌드박스 워크플로에서만 수행해야 합니다.
필수 조건
- API 액세스 권한이 있는 AppFolio Stack Partner 계정
- 대상 포트폴리오에 대해 확인된 관리형, 공급업체 발급 기본 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와 세입자 레코드 수만 반환합니다.
예시
첫 번째 통합 확인을 위해 검증된 샌드박스 클라이언트를 구성하고, 승인된 합성 부동산 페이지 하나를 쿼리한 후 주소, 이름, 유닛 번호 또는 자격 증명을 기록하지 않고 상태, 부동산 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를 참조하십시오.