Docs/API Pública/Boas Práticas

Boas Práticas de Integração

Diretrizes recomendadas pela engenharia da Inforce para maximizar a performance, resiliência e integridade dos dados integrados.

1. Normalização de Telefones (+55 com DDD)

Sempre envie os telefones no formato internacional padrão E.164 (ex: +5511999998888) ou nacional completo com DDD (ex: (11) 99999-8888). Isso garante que os corretores recebam o clique direto para WhatsApp sem falhas de numeração.

2. Paginação Consciente em Listagens

Ao consultar a lista de leads via GET /v2/leads, utilize valores de PageSize entre 20 e 100 registros. Evite buscar todo o histórico em loops concorrentes, priorizando o filtro por DataAlteracaoDe para buscar apenas atualizações incrementais.

3. Retentativas com Backoff Exponencial

Em caso de erros de rede ou status 503/429, implemente retentativas automáticas espaçadas (ex: aguardar 1s, 2s, 4s). Nunca dispare requisições contínuas em loop sem intervalo.

4. Atribuição de UTM e Origem Externa

Ao cadastrar leads de campanhas pagas, sempre preencha os campos origemExterna (ex: "Google Ads") e utm (ex: utm_source=google&utm_campaign=lancamento). Isso permite aos gestores da imobiliária auditar o ROI de cada canal no painel de relatórios.