AppFolio 설치 및 인증은(는) 무엇을 하나요?
개요
AppFolio Stack API 인증을 구성합니다. AppFolio는 Stack 파트너 프로그램을 통해 제공되는 클라이언트 ID와 클라이언트 시크릿을 사용한 HTTP Basic Auth를 사용합니다. 공개 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 Auth를 사용하는 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로 진행하세요.