技能 编程开发 部署AppFolio物业管理集成服务

部署AppFolio物业管理集成服务

v20260423
appfolio-deploy-integration
此技能提供了一份关于使用Docker部署容器化AppFolio物业管理集成服务的完整指南。内容涵盖构建生产级镜像、配置多物业环境、实现API连接健康检查,并提供了零停机时间的滚动更新策略,确保您的整个物业组合的稳定运行。
获取技能
351 次下载
概览

AppFolio Deploy Integration

Overview

Deploy a containerized AppFolio property management integration service with Docker. This skill covers building a production-ready image that connects to the AppFolio Stack API for managing properties, tenants, and work orders. Includes environment configuration for multi-property setups, health checks that verify API connectivity, and rolling update strategies for zero-downtime deployments across your property portfolio.

Docker Configuration

FROM node:20-slim AS builder
WORKDIR /app
COPY package*.json ./
RUN npm ci
COPY tsconfig.json ./
COPY src/ ./src/
RUN npm run build

FROM node:20-slim
RUN addgroup --system app && adduser --system --ingroup app app
WORKDIR /app
COPY --from=builder /app/dist ./dist
COPY --from=builder /app/node_modules ./node_modules
COPY package*.json ./
USER app
EXPOSE 3000
HEALTHCHECK --interval=30s --timeout=5s --retries=3 \
  CMD curl -f http://localhost:3000/health || exit 1
CMD ["node", "dist/index.js"]

Environment Variables

export APPFOLIO_API_KEY="af_live_xxxxxxxxxxxx"
export APPFOLIO_BASE_URL="https://your-company.appfolio.com/api/v1"
export APPFOLIO_COMPANY_ID="your-company"
export LOG_LEVEL="info"
export PORT="3000"
export NODE_ENV="production"

Health Check Endpoint

import express from 'express';

const app = express();

app.get('/health', async (req, res) => {
  try {
    const response = await fetch(`${process.env.APPFOLIO_BASE_URL}/properties`, {
      headers: { 'Authorization': `Bearer ${process.env.APPFOLIO_API_KEY}` },
    });
    if (!response.ok) throw new Error(`AppFolio API returned ${response.status}`);
    res.json({ status: 'healthy', service: 'appfolio-integration', timestamp: new Date().toISOString() });
  } catch (error) {
    res.status(503).json({ status: 'unhealthy', error: (error as Error).message });
  }
});

Deployment Steps

Step 1: Build

docker build -t appfolio-integration:latest .

Step 2: Run

docker run -d --name appfolio-integration \
  -p 3000:3000 \
  -e APPFOLIO_API_KEY -e APPFOLIO_BASE_URL -e APPFOLIO_COMPANY_ID \
  appfolio-integration:latest

Step 3: Verify

curl -s http://localhost:3000/health | jq .

Step 4: Rolling Update

docker build -t appfolio-integration:v2 . && \
docker stop appfolio-integration && \
docker rm appfolio-integration && \
docker run -d --name appfolio-integration -p 3000:3000 \
  -e APPFOLIO_API_KEY -e APPFOLIO_BASE_URL -e APPFOLIO_COMPANY_ID \
  appfolio-integration:v2

Error Handling

IssueCauseFix
401 UnauthorizedInvalid or expired API keyRegenerate key in AppFolio Stack Partner portal
403 ForbiddenMissing property access scopeRequest additional scopes from AppFolio admin
404 Not FoundIncorrect base URL or company IDVerify APPFOLIO_BASE_URL matches your subdomain
429 Rate LimitedToo many requests per minuteImplement exponential backoff with 60s window
Container exits immediatelyMissing required env varsEnsure all env vars are set before starting

Resources

Next Steps

See appfolio-webhooks-events.

信息
分类 编程开发
名称 appfolio-deploy-integration
版本 v20260423
大小 3.59KB
更新时间 2026-04-26
语言