Mapaprop

Get Started com a Feeds API

Consulte milhares de imóveis para construir o seu portal.

1. Obtenha seu access token

Registre sua aplicação e siga o Getting Started.

2. Fluxo básico

Buscamos oferecer a forma mais rápida de manter atualizada a lista de imóveis. O fluxo básico é:

  1. No dia 1, chame GET /api/action/feed-v1/get-total para conhecer o total de imóveis disponíveis.
  2. Com o total conhecido, baixe os dados em lotes de 500 imóveis usando GET /api/action/feed-v1/get-properties. Limitamos a quantidade de requests: evite fazer mais de 2 chamadas concorrentes ou você começará a receber erros HTTP 503.
  3. A partir daí, dia após dia chame GET /api/action/feed-v1/get-delta para obter a diferença (inclusões vs remoções) do dia e evitar reler grandes volumes de dados. O delta aceita data: se você perder um dia, pode pedir o que mudou naquela data específica.

O agencyId (identificador da imobiliária)

Cada imóvel do feed inclui o objeto agency com seu campo id (chamado agencyId em outros métodos): um identificador único, estável e opaco da imobiliária que publica. Trate-o como uma string opaca: guarde exatamente como você o recebe e nunca tente parsear ou interpretar.

Para que serve:

  1. Agrupar imóveis por imobiliária: todos os imóveis da mesma agência compartilham o mesmo agency.id.
  2. Devolver consultas: envie o valor como está em POST submit-question.
  3. Vincular uma agência à sua conta no seu portal: quando uma imobiliária se registra no seu portal com seu email, você pode obter o agencyId dela via Customer API (GET /api/action/customer-v1/{email}) e vincular a conta aos imóveis do feed. O email nunca viaja no feed: a própria agência o fornece ao se registrar.

O mesmo identificador é usado na Feeds API, Network API e Customer API.

Download de imagens

Pelos custos de transferência de dados, todas as imagens devem ser servidas dos seus servidores. Para isso você precisa baixá-las dos nossos. Para prevenir o mau uso, precisamos saber qual User-Agent seu bot de download usa ou de qual faixa de IPs ele vem. Contate a Mapaprop para informar. Bloqueamos todo o tráfego anônimo ou suspeito. (Exemplo de User-Agent: Empresa/Versao, como Mapaprop/1.2.3)

Com seu access token da Mapaprop você já pode acessar a Feeds API. Estes são os métodos:

GET /api/action/feed-v1/get-total

GET /api/action/feed-v1/get-properties

GET /api/action/feed-v1/get-delta

GET /api/action/feed-v1/get-delta-network

POST /api/action/feed-v1/submit-question

4. Copyright

O copyright das imagens e dos dados pertence à Mapaprop. Por meio do acordo de feed, a Mapaprop autoriza os consumidores a usar ambos.