📘

Esta sección es para aplicaciones que son o desean ser partners de EasyBroker. Si eres cliente y deseas usar la API de tu cuenta, consulta la Introducción a la API de EasyBroker.

Autenticación y país

Todos los endpoints usan la URL base /v1/integration_partners y requieren estos encabezados:

• X-Authorization: La API Key entregada a tu integración.
• Country-Code: El código del país que deseas consultar, por ejemplo MX. Tu integración debe estar activa en ese país.

En pruebas usa https://api.stagingeb.com/v1/integration_partners. En producción usa https://api.easybroker.com/v1/integration_partners.

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. La primera vez recomendamos usar el filtro published en true para obtener las propiedades publicadas en ese momento.
2. Con la respuesta de Listing Statuses usa el public_id en el endpoint de Properties para obtener los detalles de cada propiedad.
   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 encontrarás el agent_id. Obtén sus detalles en Agents y relaciónalos con la agencia correspondiente.
3. Después de procesar la propiedad, informa si fue publicada o si tuvo errores usando Property Integration.
4. Si una propiedad recibe una solicitud de información, envíala usando 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 consulta Listing Statuses cada 15 a 30 minutos para obtener propiedades nuevas, actualizadas o despublicadas.

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.