Documentation updated June 18, 2025.
Developed methods.
The following methods are currently available:
- Zonaprop API > PUT aviso : Allows publishing listings on Zonaprop (requires authentication)
- Zonaprop API > UPDATE aviso : Facilitates modifying published listings (requires authentication)
- Zonaprop API > DELETE aviso : Enables the removal of published listings (requires authentication)
- Zonaprop API > Mapping zone : Suite of methods for managing and synchronizing Zonaprop geographic zones, including mapping and cloud database persistence functionality (does not require authentication)
- Zonaprop API > Get aviso status : Allows querying the current status of a listing (requires authentication)
- Zonaprop API > Get aviso : Facilitates obtaining detailed information about a specific listing (requires authentication)
Methods to be developed
To complete the integration with Zonaprop API, additional endpoints need to be developed to fulfil the complete workflow for the publication and lead retrieval system.
The following methods are necessary to provide full functionality:
- ZonapropAuth: Implements server-side authentication (Mapaprop) to guarantee the security and integrity of the authorization process across all methods. This method is the main one required to package the Zonaprop API system for use by third parties Zonaprop API > ZonapropAuth() Private Doc
- Zonaprop Api > Get Plan : Allows querying and selecting from the available publication plans.
- GET Messages: Facilitates the retrieval of messages within specific time periods. With two methods:
- Zonaprop Api > Get Messages : all messages
- Zonaprop Api > Get Property Messages : all messages for a single listing.
- Testing environment (optional): Zonaprop provides a testing environment. The system works only with a connected account, but does not affect the real listing stock during testing.
Methods ready but not yet in production
- Zonaprop Api > Get Ads : Allows retrieving the complete list of listings (requires authentication)
Workflow
- Connect account: With a subscription to Mapaprop Business, you will be able to Connect with Zonaprop . Connecting your account integrates you with Mapaprop and allows you to use Zonaprop API.
- Request Token: Request the token from Mapaprop to be able to make calls to the Zonaprop API methods from this link https://www.mapaprop.com/dev
- Prepare your Property object: You must map your property to the Zonaprop property model. See this link Zonaprop API > Property Object
- Implement the Zone Mapping system: Here you have two options documented in Zonaprop API > Mapping zone
- Create persistent mappings: You can call the mappings endpoint and, if you do not get the mapping, generate one that will be saved in the database from that moment on and can be retrieved at any time (see examples in Zonaprop API > Mapping zone )
- Get zones and generate your own mapping: You can use the endpoints directly to get the zones and their dependencies, and generate your own mapping (see endpoints Zonaprop API > Mapping zone )
- Get your plans: Check your listing availability to know which plan you will use to publish the property with Zonaprop Api > Get Plan
- Publish your property: with Put Aviso, you can publish the property Zonaprop API > PUT aviso. Every published listing is written to the Mapaprop Property API database.
- Delete or modify a listing: with the methods Zonaprop API > UPDATE aviso and Zonaprop API > DELETE aviso you can modify and unpublish (the use of these endpoints affects the Mapaprop Property API database)
- Check the status of a listing: with Zonaprop API > Get aviso status you can check the status of a listing to update your flow or database.
- Get a listing: with Zonaprop API > Get aviso you can retrieve any listing that you have linked to your property (does not write to the database.)
- Get messages: with Zonaprop Api > Get Messages you can get all messages from your Zonaprop account. You can also get messages from a single property Zonaprop Api > Get Property Messages
Connecting your account immediately integrates you with Mapaprop, enabling you to post directly to production.
The system provides a database that acts as an intermediary between your system and Zonaprop. The database stores:
- Mappings
- Properties
The use of Mappings to create persistence and simplify your publication method justifies the use of this database (Zonaprop API > Mapping zone).
The system of publishing (Zonaprop API > PUT aviso ), editing (Zonaprop API > UPDATE aviso ) and deleting publications (Zonaprop API > DELETE aviso ) is not necessarily justified, but is maintained to develop future systems. It is therefore important to know that the information you load and modify in Zonaprop remains in an intermediate database until you delete it with the method Zonaprop API > DELETE aviso.