Guía rápida de la API

En esta página, te damos una idea de cómo implementar la API de EasyBroker y los requisitos que debes de cumplir para que tu integración sea aceptada por el equipo.

Requisitos

Tu integración deberá contar con las siguientes características:

  • Integrar cuentas de EasyBroker a tu portal
  • Publicar, actualizar y dar de baja las propiedades de nuestros clientes en tu portal
  • Crear solicitudes de contacto por medio de la API

Una vez que tu integración cumpla con estos requisitos deberás avisar al equipo de EasyBroker para que sea revisada y aprobada para producción.

Usando nuestra API por primera vez

Esta es una idea del flujo que deberá tener tu aplicación, no es obligatorio hacerlo de esta forma pero lo recomendamos para cumplir con todas las características.

  1. Con el endpoint Listing Statuses deberás obtener todas las propiedades que se envían a tu portal y obtendrás todos los cambios en el inventario (nuevas, despublicadas y actualizaciones) cada N minutos.
    1. Cuando empieces a actualizar el inventario verás que las propiedades para despublicarse estarán como published = false en listing_statuses, solo deberás desactivarlas en tu portal y no es necesario que consultes los detalles de la propiedad.
  2. Con el endpoint Properties obtendrás los detalles de la propiedad, esta es la información que utilizarás para mostrar en tu sitio.

La API está hecha para mantener el inventario en tiempo real, te recomendamos consultar los cambios mínimo 2 veces por día pero lo ideal es que sea en lapsos de 15-30 minutos.

Si eres un Partner de EasyBroker

Si ya tienes una integración con EasyBroker activa, te recomendamos actualizar todas las propiedades cuando por primera vez consumas la API. Al hacerlo, las propiedades que ya tenías en tu portal se pondrán al día.

Posteriormente con el endpoint Listing Statuses deberás obtener todas las propiedades que se envían a tu portal y obtendrás todos los cambios en el inventario (nuevas, despublicadas y actualizaciones) cada N minutos.

  1. Cuando empieces a actualizar el inventario verás que las propiedades para despublicarse estarán como published = false en listing_statuses, solo deberás desactivarlas en tu portal y no es necesario que consultes los detalles de la propiedad.

Recomendaciones

  • Intenta mantener tu sitio casi en tiempo real, te recomendamos consultar los cambios cada 15-30 minutos.
  • Puedes tener un proceso de respaldo que se ejecute todos los días a la media noche para cubrir el caso de que alguna propiedad se haya quedado sin sincronizar por algún motivo.
    Dándole 1 hora para ejecutarse y que durante esa ventana no se ejecute el otro proceso que se ejecuta cada N minutos:
    • Con listing_statuses obtienes todo lo que cambió en los últimos 2 días
    • Haces lo mismo que en el paso 2,3 y 4 del proceso anterior.

⚠️

Toma en cuenta que tenemos un límite de 20 request por segundo, así que deberás de ajustar tu integración para no obtener errores.

❗️

Si tienes dudas sobre algún error en especial contáctanos por medio de nuestro formulario de contacto para ayudarte.