Sou cliente do Mapaprop
Os outros fluxos estão escritos para um integrador: um app que publica o inventário de outras imobiliárias. Se você contratou Property API para automatizar a sua própria conta, o único "cliente" é você — e há cinco coisas que funcionam de modo diferente.
1 · seu token Configuração > API Token um clique, não vence
2 · sua ficha POST /customers uma vez
3 · seu portal você conecta sua conta SIM, de novo. Veja abaixo
4 · você publica POST /properties branchRef = seu branchId
5 · suas consultas GET /leads?portal=mapapropapi sua caixa, sem gastar cota
1 · O token não se pede, se ativa
Você não registra um app nem espera credenciais: contrata Property API e ativa seu Token de API com um clique em Configuração > API Token. É o mesmo token de todos os seus serviços de API e não vence. Como se faz: Property API Token.
2 · A ficha: sim, você também a declara
POST /property-v1/customers x-client-ref: minha-imobiliaria
{ "name": "…", "email": "…", "phone1": "…" }
Você escolhe o x-client-ref e ele é o mesmo em todas as suas chamadas. Devolvemos nosso id
(MAPAPROP-PA-000001), que vale a pena guardar.
Por quê, se o Mapaprop já tem seus dados? Porque é o que é publicado como contato do anúncio, e
a API não presume: você declara uma vez e fica explícito. Mudar depois é um PUT na mesma rota.
3 · 🔴 A conta do portal se conecta de novo
Mesmo que você já publique nesse portal pelo Mapaprop. A conexão do Property API é própria e separada da que a web usa: são dois caminhos diferentes para o mesmo portal, e conectar um não conecta o outro.
Funciona como para qualquer cliente, e a forma é definida pelo portal: com um link ou com a credencial.
4 · Suas filiais: envie o branchId, nada mais
Isto é o que mais se simplifica para você. Suas filiais já existem na sua conta, com o id e o nome delas, então você não declara nada:
POST /property-v1/properties
{ "canonical": { }, "branchRef": 777 }
Esse número é o da sua filial, e você o lê com
GET /branches. Sem declarar, sem batizar.
E também pode administrá-las, tudo opcional:
| Você quer… | Você faz |
|---|---|
que seu código fale de "centro" e não de um número | declara o mapeamento em branches |
| criar uma filial nova | declara com os dados dela em PUT /customers e devolvemos o id |
| editar uma | PUT /branches/{branchRef} |
| apagar uma | DELETE /branches/{branchRef} |
Pode nomeá-la pela sua ref ou diretamente pelo seu branchId: as duas formas funcionam.
O dado de uma filial da sua conta vive no Mapaprop, e continua a ser assim. O que mudou é que
agora tem uma porta mais para o escrever: o PUT acima escreve no Mapaprop, não uma cópia ao
lado. Por isso não há duas versões do mesmo telefone — há um único dado e duas formas de o editar, a
webapp e a API.
O que a ficha declara sobre uma filial já vinculada não se publica: ao publicar, o contacto sai do Mapaprop. A ficha é o mapeamento, não o dado.
Apagar uma filial move as suas propriedades. As suas propriedades, contactos, placas e
utilizadores passam para outra filial, e isso não se desfaz. Com 3 ou mais filiais escolhe qual com
?targetBranchRef=; com 2 vão para a principal.
O detalhe está aqui.
5 · As suas consultas: as da sua própria caixa, com uma chamada
🟢 Aqui você tem algo que um integrador ainda não tem: as consultas que entram na sua conta Mapaprop — pelo seu site, pelo seu chat, pelo portal da Mapaprop, ou por um portal que as deixa na sua caixa — são lidas com uma única chamada.
curl "https://property-api.mapaprop.com/property-v1/leads?portal=mapapropapi&fromDate=20260101" \
-H "Authorization: Bearer $TOKEN"
| Não gasta cota de nenhum portal | a fonte é a sua própria conta, então paginar não lhe custa chamadas |
| Trazem a thread | o data.questionId agrupa a conversa: junte as mensagens em vez de abrir um registro para cada uma |
| Janela de um ano | por pedido. Mais do que isso devolve 400 window_too_wide |
| E também chegam sozinhas | se você declarou um webhook, as mesmas consultas chegam por ali sem serem pedidas |
Funciona porque o seu token é de uma conta Mapaprop, e é a diferença em relação a um integrador.
Esta fonte resolve a conta a partir do token, então devolve as suas consultas e não as de outro.
Um integrador que experimente ?portal=mapapropapi recebe 400 no_mapaprop_account: o que serve
para ele é o webhook.
O detalhe está em as consultas de toda a conta.
E daí em diante, tudo igual
Publicar, os estados, as consultas e a baixa funcionam exatamente como nos outros fluxos:
Seus imóveis entram na sua conta do Mapaprop. Ao contrário dos de um integrador —que vivem apenas no Property API— os seus são registrados também na sua conta, então você os vê na web como qualquer outro. É o que faz o adicional valer a pena.
Relacionado
- Dar de alta um cliente — o mesmo percurso contado para um integrador, com mais detalhe de cada passo
POST /customers— todos os campos da fichaGET /branches— suas filiais e os ids delasPUT /branches/{branchRef}eDELETE— editar e apagar uma