BETA

Publicação

Quando o imóvel já está cadastrado e a conta do portal conectada, é aqui que se publica — e se dá baixa.

As três operações vão para a mesma rota, e o que muda é o método:

/property-v1/properties/{paId}/publication/{portal}

Os três métodos

O que fazScope
PUTPublica o imóvel. Chamá-lo de novo atualiza, não duplica{portal}:publish
DELETEDá baixa no anúncio. Idempotente: se já não estava, responde 200 do mesmo jeito{portal}:publish
GETPergunta ao portal como está o anúncio: sua URL, se continua online, as visitas. ⚠️ gasta cota{portal}:publish
GET/PUT …/positioningPagar por posição: o saldo, o teto, onde o anúncio está e uma simulação de qual posição você conseguiria. ⚠️ gasta cota, e a simulação custa uma chamada por valor{portal}:publish

Os três usam o mesmo scope: quem pode publicar pode dar baixa e consultar.

E os três respondem igual quando a recusa é sobre o estado da CONTA. Se o portal disser que já não reconhece a conta do seu cliente (409 portal_account_unlinked) ou que a tem bloqueada (409 portal_account_blocked), você recebe com o mesmo código no PUT, no DELETE e no GET — assim você não precisa escrever três leituras do mesmo fato.

⚠️ E nos três deixamos o seu registro como estava. Uma recusa desse tipo não diz nada sobre o anúncio: o portal nem olhou para ele. O que muda é a resposta, não o que afirmamos do anúncio.

📌 Não há um quarto método para o ESTADO da propriedade (reservada, vendida, alugada): viaja dentro do objeto e é aplicado dentro do PUT — o estado da propriedade no portal.

O GET desta rota não é o de /properties/{paId}. Aquele lê o que já temos guardado e é gratuito; este pergunta ao portal e gasta uma chamada da cota do cliente. São duas operações distintas.

Os portais

Esta tabela é a referência: o resto da documentação é genérico de propósito e manda você para cá em vez de repetir o dado de um portal como se valesse para todos.

Portal{portal} na rotaChave em publicationPublicar
Zonapropzonapropapizonaprop✅ disponível
Argenpropargenpropapiargenprop✅ disponível — anúncios soltos e empreendimentos
Cabapropcabapropapicabaprop⏳ ainda não
MercadoLibremercadolibreapimercadolibre⏳ ainda não
Mapapropmapapropapi—✅ disponível — veja abaixo: não é um portal externo

Mapaprop está na tabela, mas não é um portal externo, e essa diferença muda três coisas: não há conta a conectar (é a conta do seu cliente, a mesma do aplicativo), não consome a cota de ninguém e não tem chave em publication porque não há nada a configurar. O que ele tem de próprio: publicar ali também publica nas redes das quais o seu cliente faz parte, e despublicar não retira os anúncios dos portais externos. O detalhe está em Mapaprop.

O portal tem dois nomes e eles não são intercambiáveis. Na rota vai o nome da API (zonapropapi); dentro da chave publication vai o nome curto (zonaprop). Se você os cruzar, dizemos com o nome na mão: dentro de publication sai portal desconocido. Válidos: argenprop, zonaprop, cabaprop, mercadolibre, e na rota sai portal_not_supported.

Hoje a PropertyAPI publica na Argentina. Os quatro portais são argentinos ou estão habilitados só ali: Argenprop e Cabaprop não existem em outros países, e na Zonaprop e no MercadoLibre a habilitação por país é um passo que ainda não demos. Se o seu cliente não é da Argentina, você pode cadastrar e verificar o inventário dele do mesmo jeito — o que ele não tem é portal para publicar. Escreva para dev@mapaprop.com se precisar de outro país: ajuda a gente a priorizar.

"Ainda não" se aplica só a publicar. O resto já funciona nos quatro: você pode conectar a conta, cadastrar o imóvel e verificá-lo — o verificador diz, portal por portal, se aquele anúncio sairia. Assim você pode ter a sua integração pronta antes de o portal ser habilitado.

O que muda em cada portal

ZonapropArgenpropCabapropMercadoLibre
Como se conectaum link que o seu cliente abreum link ou credencial — o link é o caminho recomendadocredencial (OAuth)credencial (OAuth)
A credencialnão existe: a autorização fica do lado do portalvocê a obtém e nós a guardamos criptografadaidemidem
Cota de chamadas1.500 por mês e por imobiliáriao portal defineo portal defineo portal define
Planos de publicaçãonomeados e consultáveisnão usa planos: pontos de assinatura, que o portal não publica pela API——
Seus dados próprios em publicationplan · branch · developmentCategoryadvertiserId · visiblebranchOfficeIdlistingTypeId · condition · sellerContact
Empreendimentos✅ as unidades viajam dentro da publicação do empreendimento: uma única chamada✅ mas cada unidade é publicada primeiro e depois o empreendimento as agrupa: o fluxo explica⏳ ainda não⏳ ainda não
O que um re-publish aceita alterarsem mediçãotudo menos o type — inclusive a zona. O tipo de imóvel não pode ser alterado em um anúncio que já existe: é preciso dar baixa e publicar novamente——

A cota é do cliente, não sua nem nossa. Ele a contrata com o portal, a sua integração a gasta, e cada portal a define à sua maneira — o número da Zonaprop não é a norma da API. Detalhe desse caso: Cota mensal e limites.

Desses dados próprios, publication controla o tipo, não a presença: se você mandar advertiserId como texto, ele marca, mas não exige que você o mande. O que cada portal realmente precisa é o que o PUT diz quando falta — no seu 409, com o nome do campo. O que significa cada um: a chave publication.

Cada portal com seção própria tem o seu lá: Zonaprop · Argenprop · Cabaprop ainda não tem seção própria.

E a configuração

A chave publication — o plano e os dados de portal que viajam dentro do objeto, para não ter que mandá-los em cada chamada.

Antes de publicar

Três coisas, nesta ordem:

  1. A ficha do seu cliente — Clientes
  2. A conta dele no portal conectada — Conectar com um link ou com a credencial
  3. O imóvel cadastrado, com o seu paId — Cadastro de imóveis