Documentação atualizada em June 18, 2025.
Métodos desenvolvidos.
A seguir estão detalhados os métodos disponíveis:
- Zonaprop API > PUT aviso : Permite a publicação de anúncios no Zonaprop (requer autenticação)
- Zonaprop API > UPDATE aviso : Facilita a modificação de anúncios publicados (requer autenticação)
- Zonaprop API > DELETE aviso : Possibilita a exclusão de anúncios publicados (requer autenticação)
- Zonaprop API > Mapping zone : Conjunto de métodos para gerenciamento e sincronização de zonas geográficas do Zonaprop, incluindo funcionalidades de mapeamento e persistência em banco de dados na nuvem (não requer autenticação)
- Zonaprop API > Get aviso status : Permite consultar o estado atual de um anúncio (requer autenticação)
- Zonaprop API > Get aviso : Facilita a obtenção de informações detalhadas de um anúncio específico (requer autenticação)
Métodos a desenvolver
Para completar a integração com a Zonaprop API, é necessário o desenvolvimento de endpoints adicionais para cumprir o fluxo completo de trabalho do sistema de publicação e obtenção de leads.
Os seguintes métodos são necessários para fornecer funcionalidade completa:
- ZonapropAuth: Implementa a autenticação do servidor (Mapaprop) para garantir a segurança e integridade do processo de autorização em todos os métodos. Este método é o principal necessário para empacotar o sistema da Zonaprop API para uso de terceiros Zonaprop API > ZonapropAuth() Private Doc
- Zonaprop Api > Get Plan : Permite consultar e selecionar entre os planos de publicação disponíveis.
- GET Messages: Facilita a recuperação de mensagens dentro de períodos específicos. Com dois métodos:
- Zonaprop Api > Get Messages : todas as mensagens
- Zonaprop Api > Get Property Messages : todas as mensagens de um único anúncio.
- Ambiente de testes (opcional): O Zonaprop fornece um ambiente de testes. O sistema funciona apenas com conta conectada, mas não afeta o estoque real no momento dos testes.
Métodos prontos mas ainda não em produção
- Zonaprop Api > Get Ads : Permite recuperar a listagem completa de anúncios (requer autenticação)
Fluxo de trabalho
- Conectar conta: Com uma assinatura do Mapaprop Business, você poderá Conectar com Zonaprop . Conectar sua conta integra você ao Mapaprop e permite que você use a Zonaprop API.
- Solicitar Token: Solicite o token ao Mapaprop para poder realizar chamadas aos métodos da Zonaprop API através deste link https://www.mapaprop.com/dev
- Preparar seu objeto Imóvel: Você deve mapear seu imóvel ao modelo de imóvel Zonaprop. Ver este link Zonaprop API > Property Object
- Implementar o sistema de Mapeamento de Zonas: Aqui você tem duas opções documentadas em Zonaprop API > Mapping zone
- Criar mapeamentos persistentes: Você pode chamar o endpoint de mapeamentos e, se não obtiver o mapeamento, gerar um que ficará salvo no banco de dados a partir daquele momento e poderá ser chamado sempre (ver exemplos em Zonaprop API > Mapping zone )
- Obter zonas e gerar seu próprio mapeamento: Você pode usar diretamente os endpoints para obter as zonas e suas dependências, e gerar seu próprio mapeamento (ver endpoints Zonaprop API > Mapping zone )
- Obter seus planos: Consulte a disponibilidade de anúncios para saber com qual plano você publicará o imóvel com Zonaprop Api > Get Plan
- Publicar seu imóvel: com Put Aviso, você pode publicar o imóvel Zonaprop API > PUT aviso. Todo anúncio publicado fica gravado no banco de dados da Mapaprop Property API.
- Excluir ou modificar um anúncio: com os métodos Zonaprop API > UPDATE aviso e Zonaprop API > DELETE aviso você pode modificar e despublicar (o uso desses endpoints afeta o banco de dados da Mapaprop Property API)
- Conhecer o estado de um anúncio: com Zonaprop API > Get aviso status você pode conhecer o estado de um anúncio para atualizar seu fluxo ou banco de dados.
- Obter um anúncio: com Zonaprop API > Get aviso você pode obter qualquer anúncio que tenha vinculado ao seu imóvel (não escreve no banco de dados.)
- Obter mensagens: com Zonaprop Api > Get Messages você pode obter todas as mensagens da sua conta Zonaprop. Você também pode obter as mensagens de um único imóvel Zonaprop Api > Get Property Messages
Conectar sua conta imediatamente integra você ao Mapaprop, habilitando-o a postar diretamente em produção.
O sistema fornece um banco de dados que serve como intermediário entre o seu sistema e o Zonaprop. O banco de dados armazena:
- Mapeamentos
- Imóveis
O uso de mapeamentos para criar persistência e simplificar seu método de publicação justifica o uso deste banco de dados (Zonaprop API > Mapping zone).
O sistema de publicar (Zonaprop API > PUT aviso ), editar (Zonaprop API > UPDATE aviso ) e excluir publicações (Zonaprop API > DELETE aviso ) não está necessariamente justificado, mas é mantido para desenvolver sistemas futuros. Portanto, é importante saber que as informações que você carrega e modifica no Zonaprop permanecem em um banco de dados intermediário até que você as exclua com o método Zonaprop API > DELETE aviso.