tag: BETA

El siguiente documento describe el flujo de implementación para integrar la API de Zonaprop en tu sistema. Aquí encontrarás una guía detallada de los métodos disponibles, los que están en desarrollo, y el proceso paso a paso para una implementación exitosa.

Métodos desarrollados.

A continuación se detallan los métodos disponibles:

• Zonaprop API > PUT aviso : Permite la publicación de avisos en Zonaprop (requiere autenticación)
• Zonaprop API > UPDATE aviso : Facilita la modificación de avisos publicados (requiere autenticación)
• Zonaprop API > DELETE aviso : Posibilita la eliminación de avisos publicados (requiere autenticación)
• Zonaprop API > Mapping zone : Suite de métodos para la gestión y sincronización de zonas geográficas de Zonaprop, incluyendo funcionalidades de mapeo y persistencia en base de datos cloud (no requiere autenticación)
• Zonaprop API > Get aviso status : Permite consultar el estado actual de un aviso (requiere autenticación)
• Zonaprop API > Get aviso : Facilita la obtención de información detallada de un aviso específico (requiere autenticación)

Métodos a desarrollar

Para completar la integración con Zonaprop API, se requiere del desarrollo de Endpoints adicionales para cumplir con el flujo completo de trabajo del sistema de publicacion y obtencion de Leads.

Los siguientes métodos son necesarios para proporcionar una funcionalidad completa:

• ZonapropAuth: Implementa la autenticación del servidor (Mapaprop) para garantizar la seguridad e integridad del proceso de autorización en todos los métodos. Este metodo es el principal que se requiere para empaquetar el sistema de Zonaprop API para el uso de terceros Zonaprop API > ZonapropAuth() Private Doc
• Zonaprop Api > Get Plan : Permite consultar y seleccionar entre los planes de publicación disponibles.
• GET Messages: Facilita la recuperación de mensajes dentro de períodos específicos. con dos metodos:
  • Zonaprop Api > Get Messages : todos los mensajes
  • Zonaprop Api > Get Property Messages : todos los mensajes de un aviso.
• Entorno de pruebas (opcional): Zonaprop proporciona un entorno de pruebas. El sistema funciona solo con cuenta conectada, pero no afecta al stock real al momento de hacer las pruebas.

Metodos listos pero no en produccion

• Zonaprop Api > Get Ads : Permite recuperar el listado completo de avisos (requiere autenticación)

Flujo de trabajo

1. Conectar cuenta: Con una suscripcion a Mapaprop Business, podras Conectar con Zonaprop . Conectar cuenta te integra con Mapaprop y permite que uses Zonaprop API.
2. Solicitar Token: Solicita el token a Mapaprop para poder realizar las llamadas a los Metodos de Zonaprop API desde este link https://www.mapaprop.com/dev
3. Preparar tu objeto Propiedad: Debes mapear tu propiedad al modelo de una propiedad Zonaprop. Ver este link Zonaprop API > Property Object
4. Implementar el sistema de Mapeo de Zonas: aqui contas con dos opciones documentadas en Zonaprop API > Mapping zone
   1. Crear mapeos persistentes: Podes llamar al endpoint de mapeos, y si no obtenes el mapeo, generar uno que a partir de ese momento quedara guardado en la base de datos y podras llamarlo siempre (ver ejemplos en Zonaprop API > Mapping zone )
   2. Obtener zonas y generar tu propio mapeo: Podes usar directamente los endpoints para obtener las zonas y sus dependencias, y generar tu propio mapeo (ver endpoints Zonaprop API > Mapping zone )
5. Obtener tus planes: consulta tu disponibilidad de avisos para conocer con que plan publicaras la propiedad con Zonaprop Api > Get Plan
6. Publicar tu propiedad: con Put Aviso, podras publicar la propiedad Zonaprop API > PUT aviso. Todo aviso publicado queda escrito en la base de datos de Mapaprop Property API.
7. Borrar o modificar aviso: con los metodos Zonaprop API > UPDATE aviso y Zonaprop API > DELETE aviso podras modificar y despublicar (el uso de estos endpoints afectan a la base de datos de Mapaprop Property API)
8. Conoce el estado de un aviso: con Zonaprop API > Get aviso status podras conocer el estado de un aviso para actualizar tu flujo o base de datos.
9. Obtener aviso: con Zonaprop API > Get aviso podras obtener cualquier aviso que hayas vinculado a tu propiedad (no escribe en base de datos.)
10. Obtener mensajes: con Zonaprop Api > Get Messages podras obtener todos los mensajes de tu cuenta Zonaprop. También podes obtener los mensajes desde una sola propiedad Zonaprop Api > Get Property Messages

Base de datos de Mapaprop Property API

El sistema provee una base de datos que intermedia entre tu sistema y Zonaprop. La base de datos guarda:

• Mapeos
• Propiedades

El uso de Mapeos para crear persistencia y simplificar tu metodo de publicacion justifica el uso de esta base de datos (Zonaprop API > Mapping zone).

El sistema de publicar (Zonaprop API > PUT aviso ), editar (Zonaprop API > UPDATE aviso ) y borrar publicaciones (Zonaprop API > DELETE aviso ) no esta necesariamente justificado, pero se mantiene para desarrollar sistemas futuros. Por lo tanto es importante que sepas que la informacion que vas cargando y modificando en zonaprop, queda en una base de datos intermedia hasta que la elimines con el metodo Zonaprop API > DELETE aviso.