Instalação e Autenticação AppFolio
Visão Geral
Configure a autenticação da API do AppFolio Stack. O AppFolio usa HTTP Basic Auth com um client ID e client secret, fornecidos através do programa de parceiros Stack. Não existe um SDK npm público — use chamadas REST API diretamente.
Pré-requisitos
- Conta de parceiro AppFolio Stack (appfolio.com/stack)
- Client ID e Client Secret do AppFolio
- Node.js 18+ ou Python 3.10+
Instruções
Passo 1: Obter Credenciais da API
# As credenciais da API do AppFolio Stack vêm do programa de parceiros
# 1. Inscreva-se em appfolio.com/stack/become-a-partner
# 2. Complete a revisão de integração
# 3. Receba client_id e client_secret
cat > .env << 'ENVFILE'
APPFOLIO_CLIENT_ID=seu-client-id
APPFOLIO_CLIENT_SECRET=seu-client-secret
APPFOLIO_BASE_URL=https://sua-empresa.appfolio.com/api/v1
ENVFILE
chmod 600 .env
echo ".env" >> .gitignore
Passo 2: Criar Cliente 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(`Conectado! Encontradas ${response.data.length} propriedades`);
return true;
} catch (error: any) {
console.error(`Falha na conexão: ${error.response?.status} ${error.message}`);
return false;
}
}
get http(): AxiosInstance { return this.api; }
}
export { AppFolioClient };
Passo 3: Verificar Conexão
# Teste rápido com curl
curl -u "${APPFOLIO_CLIENT_ID}:${APPFOLIO_CLIENT_SECRET}" \
"${APPFOLIO_BASE_URL}/properties" | jq '.[0]'
Endpoints da API
| Recurso | Endpoint | Métodos |
|---|---|---|
| Propriedades | /api/v1/properties | GET |
| Unidades | /api/v1/units | GET |
| Inquilinos | /api/v1/tenants | GET |
| Contratos de Locação | /api/v1/leases | GET, POST |
| Contas | /api/v1/bills | GET, POST |
| Fornecedores | /api/v1/vendors | GET |
| Proprietários | /api/v1/owners | GET |
| Relatórios | /api/v1/reports | GET |
Saída
- Credenciais da API configuradas em
.env - Cliente REST TypeScript com autenticação Basic Auth
- Conectividade verificada com a API AppFolio
Tratamento de Erros
| Erro | Causa | Solução |
|---|---|---|
401 Unauthorized | Credenciais inválidas | Verifique client_id/secret com AppFolio |
403 Forbidden | Não é parceiro Stack | Complete a inscrição como parceiro |
404 Not Found | URL base errada | Use o formato sua-empresa.appfolio.com |
| Timeout | Problema de rede | Verifique se o firewall permite HTTPS para appfolio.com |
Recursos
Próximos Passos
Prosseguir para appfolio-hello-world para sua primeira consulta de propriedade.