Primeiros passos com a Portal API
Construa seu próprio portal usando a Portal API do Mapaprop para pesquisar o inventário imobiliário dos clientes.
1. Obtenha seu access token
Registre sua aplicação em Primeiros passos.
2. Fluxo básico
Um portal é montado em cinco passos. Os três primeiros são a busca; os dois últimos, a ficha.
1 · Busque os catálogos do país, uma vez
settings/types/{country},
settings/operations/{country}
e settings/currencies/{country}
são o catálogo do país: mudam muito pouco. Busque-os ao iniciar e armazene-os em cache — não os
peça a cada busca.
2 · Resolva a zona que o visitante digita
zones/suggestions converte texto
livre em um código de zona. É o que alimenta o autocompletar da busca, e o code que devolve é o que
depois se usa para filtrar.
3 · Busque
properties/{country} com os
filtros montados nos dois passos anteriores. Devolve total para paginar e a lista de imóveis.
4 · Exiba a ficha
properties/{propertyHash}
traz o imóvel completo. Registre a visita com
PUT properties/{propertyHash}/hits:
é o que permite à imobiliária ver que o seu anúncio está sendo visto no seu portal.
Se for um empreendimento (development: true), a ficha traz também o seu grupo de campos e a
lista de ids das suas unidades em developmentProperties. Para exibi-las, peça-as com
development/properties.
development/properties não resolve "as unidades de X": filtra pelos ids que você envia. Se
passar o id do empreendimento em vez dos de developmentProperties, devolve o próprio
empreendimento — e nada na resposta avisa que isso aconteceu. A seção de unidades acaba exibindo
o projeto como a sua própria e única unidade.
5 · Receba a consulta
POST messages envia a consulta do visitante
à imobiliária. Exige o userAgent, o referer e o ip reais do navegador: são a verificação
antispam, e enviá-los inventados faz com que a consulta fique retida.
O opcional, dependendo do portal que você montar
branchesebranches/{seoUrl}/propertiesse o seu portal navegar por filiais.customersse você listar imobiliárias.featuredspara o destaque da home.sitemap/search-url/{country}para gerar as suas URLs de busca indexáveis.
3. Serviços disponíveis
GET /api/action/portal-v2/settings/operations/{country}
GET /api/action/portal-v2/settings/types/{country}
GET /api/action/portal-v2/settings/currencies/{country}
GET /api/action/portal-v2/zones/suggestions
GET /api/action/portal-v2/properties/{country}/
POST /api/action/portal-v2/sitemap/search-url/{country}
GET /api/action/portal-v2/properties/{propertyHash}
GET /api/action/portal-v2/development/properties
PUT /api/action/portal-v2/properties/{propertyHash}/hits
POST /api/action/portal-v2/messages
GET /api/action/portal-v2/customers
GET /api/action/portal-v2/branches
GET /api/action/portal-v2/branches/{seoUrl}/properties
GET /api/action/portal-v2/featureds
GET /api/action/portal-v2/properties/{propertyHash}/share-branch/{branchSeoUrl}