AppFolio Hello World
Visão Geral
Comece a usar a API do AppFolio Property Manager através de uma configuração de cliente verificada e emitida pelo provedor. Esta skill aborda leituras seguras iniciais para uma listagem de propriedades e uma contagem de inquilinos; operações de criação ou atualização pertencem apenas a um fluxo de trabalho sintético separadamente aprovado.
Pré-requisitos
- Conta de parceiro AppFolio Stack com acesso à API
- Um URL base gerenciado e emitido pelo provedor, e um cliente de autenticação confirmado para o portfólio alvo; não use um hostname ou esquema de credenciais adivinhado
- Node.js 18+ e TypeScript
Instruções
Passo 1: Configurar o Cliente
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;
}
Passo 2: Listar Propriedades
const properties = await appfolioFetch("/properties?page_size=10");
console.log(`Encontradas ${properties.length} propriedades`);
properties.forEach((p: any) => console.log(` ID da propriedade: ${p.id}`));
Passo 3: Obter Detalhes dos Inquilinos
const tenants = await appfolioFetch(`/tenants?property_id=${properties[0].id}`);
console.log(`Recuperados ${tenants.length} registros de inquilinos para o fixture aprovado`);
Passo 4: Parar Antes de Escritas
// Não crie uma ordem de serviço como teste de início rápido. Continue apenas com o
// fluxo de trabalho sintético e idempotente em appfolio-core-workflow-b.
Saída
Uma execução bem-sucedida prova que o cliente gerenciado e um endpoint de leitura segura aprovado funcionam, retornando apenas IDs de propriedades e uma contagem de registros de inquilinos em sua saída local.
Exemplos
Para uma primeira verificação de integração, configure o cliente de sandbox verificado, consulte uma página de propriedade sintética aprovada e confirme seu status, IDs de propriedades e contagem de inquilinos sem gravar endereços, nomes, números de unidades ou credenciais. Não crie uma ordem de serviço meramente para testar o acesso. Se o contrato do portfólio, o fixture de leitura segura ou a autorização de resposta não estiverem verificados, pare a execução e use o processo de staging do proprietário da credencial antes de tentar qualquer mutação.
Tratamento de Erros
| Erro | Causa | Solução |
|---|---|---|
401 Unauthorized | client_id ou secret inválido | Verifique as credenciais nas variáveis de ambiente |
403 Forbidden | Escopo da API não concedido | Verifique as permissões do Stack Partner para o endpoint |
404 Not Found | URL base ou endpoint errado | Confirme seu subdomínio da empresa e a versão da API |
422 Unprocessable | Campos obrigatórios ausentes | Valide property_id e os parâmetros obrigatórios do corpo |
429 Too Many Requests | Limite de taxa excedido | Adicione atraso de backoff, faça requisições em lote |
Recursos
Próximos Passos
Veja appfolio-core-workflow-a para fluxos de trabalho completos de gerenciamento de propriedades e inquilinos.