📘

Esta sección de la documentación y las guías que contiene son para uso exclusivo de las aplicaciones que desean ser o son partners de EasyBroker, si eres un cliente y deseas usar la API te recomendamos ir a la Introducción a la API de EasyBroker

Requisitos

La integración con tu aplicación deberá cumplir con las siguientes características:

• Enlazar y desenlazar cuentas de EasyBroker a tu aplicación usando un ID único.
• Publicar, actualizar y dar de baja las propiedades de nuestros clientes en tu portal usando los endpoints de Listing Statuses y Properties.
• Informar el estatus de la publicación usando el endpoint de Property Integration.
• Crear solicitudes de contacto usando nuestro endpoint de Contact Request

Una vez que tu integración cumpla con estos requisitos deberás avisar al equipo de EasyBroker para pasar a la fase de pruebas y una vez aprobada, nuestros clientes podrán conectarse a tu aplicació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, ya que es la primera vez te recomendamos usar el filtro published en true y de esa forma solo obtendrás las propiedades publicadas en el momento que hagas la consulta.
2. Con la respuesta que tengas de tu consulta a Listing Statuses deberás usar el public_id en el endpoint de Properties y de esa forma podrás obtener los detalles de la propiedad. En este paso deberás iterar las veces que sea necesario de acuerdo a la cantidad de resultados que obtengas en tu consulta a Listing Statuses.
   1. Dentro de los detalles de las propiedades siempre encontrarás el agency_id, recomendamos encarecidamente usar este ID para relacionar toda la información de cada agencia.
   2. Si la propiedad está asignada a un agente en específico podrás encontrar el agent_id, podrás obtener sus detalles usando el endpoint de Agents. También recomendamos relacionar esta información al ID de la agencia perteneciente.
3. Una vez que tengas los detalles de las propiedades y proceses la información de tu lado, deberás enviarnos el estatus de la publicación para saber si la propiedad fue publicada exitosamente o si hubo algún error. Esto deberás hacerlo usando el endpoint de Property Integration.
4. Por último, si una propiedad está publicada y recibe una nueva solicitud de información deberás enviar la información usando el endpoint Contact Request

Después de consumir la información por primera vez recomendamos consultar los cambios mínimo 2 veces por día pero lo ideal es que sea en lapsos de 15-30 minutos, ya que la API está hecha para mantener el inventario en tiempo real.

Si ya 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 una hora en especial hora para ejecutarse y que durante esa ventana no se ejecute ningún otro proceso .
  • Recuerda que deberás cumplir con enviar el estatus de cada publicación por medio del endpoint de Property Integrations.

❗️

Importante - Rate Request

Los endpoints de nuestra API tienen un límite de 20 requests por segundo, por favor respeta esta regla para no tener problemas al momento de hacer tus consultas.

❗️

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