API de EasyBroker

¿Para qué sirve la API de EasyBroker?

Con la API podrás desarrollar tu propio sitio web o aplicación e integrarla con tu cuenta de EasyBroker para consultar las propiedades de tu empresa y crear o actualizar los clientes potenciales captados. Esto te permite crear un sitio para mostrar tus anuncios a la medida de tus necesidades en vez de usar las plantillas ofrecidas por EasyBroker.

La API se encuentra disponible como una Beta pública para todas las cuentas pagadas de EasyBroker. Estamos actualizando la API para que en el futuro cercano puedas filtrar con mayor precisión y también puedas consultar tus contactos, así que mantente al tanto de nuestros avisos para enterarte de novedades.

¿Qué necesito para utilizarla?

  • Conocimientos técnicos de desarrollo de sistemas y de APIs REST.
  • Conocimiento de HTML y CSS si vas a crear un sitio web a la medida.
  • Tener una cuenta de paga con EasyBroker.
  • Tener tu API Key, esta se encuentra en la sección API de la página de configuraciones generales de tu inmobiliaria.

Tu API Key

Antes de continuar, ten en cuenta que el API Key es un dato sensible que permite el acceso a la información privada de los contactos y propiedades de tu cuenta, así como a crear nuevos contactos y propiedades. Asegúrate de compartirlo sólo con personas de confianza.

Cada cuenta tiene un API Key único que debe ser usado para autenticar tu aplicación y permitir que se conecte a tu cuenta de EasyBroker. Podrás encontrarlo entrando en Configuraciones y luego API para programadores.

Si necesitas desactivar una aplicación que ya está conectada con el API de EasyBroker o desconfías de quien conoce tu API Key, puedes generar uno nuevo haciendo clic en Regenerar. Sólo ten en cuenta que si ya estabas usando el anterior necesitarás actualizarlo en tus integraciones para que sigan funcionando. 

¿Cómo puedo comenzar a usarla?

Si deseas hacer pruebas rápidas del funcionamiento de la API puedes entrar a nuestro Playground donde podrás conocer todo lo que ofrece la API sin programar ni una sola línea de código. 

Cuando estés listo para comenzar a desarrollar tu sistema tenemos 2 opciones para continuar:

  • Si conoces el lenguaje de programación Ruby ofrecemos una gema oficial para que tu integración sea más sencilla.
  • Si vas a utilizar otros lenguajes de programación necesitarás crear las interacciones tu mismo, en la siguiente sección te mostraremos algunos ejemplos de cómo hacer esto utilizando el Playground.

¿Qué puedo hacer con la API?

En este momento puedes crear solicitudes de información de clientes potenciales y consultar, filtrar y ver los detalles de todo tu inventario de propiedades. 

Para realizar cualquier consulta o petición necesitamos autenticarnos utilizando nuestra API key, es muy importante que no la compartas con personas ajenas a tu empresa porque con ella pueden ver toda la información privada de tu inventario e incluso crear clientes potenciales falsos.

Autenticación

La autenticación en el Playground es muy sencilla, primero necesitas dar clic en el botón “Authorize”:

En el cuadro de diálogo que se muestra deberás pegar tu API key y dar clic en “Authorize”:

Cuando lo hagas puedes cerrar el cuadro de diálogo y te darás cuenta que el candado del botón “Authorize” ahora está cerrado, lo que significa que ya puedes comenzar a probar las funcionalidades de la API.

Consultar el listado de tus propiedades

Para comenzar, da clic en el apartado “/properties”, esto desplegará la información que puedes pedir a esa dirección.

Para realizar una consulta de prueba da clic en el botón “Try it out”, esta habilitará todos los campos de filtros que puedes usar (Pronto agregamos más) en esta ruta.

 En el campo search necesitas remover los filtros que aparecen por defecto, de lo contrario no tendríamos ningún resultado al ejecutar nuestra consulta.

Ahora demos clic en el botón “Execute”, pero ¡oh no! Parece que tenemos un error, nuestra cuenta está desactivada por falta de pago.

Después de realizar nuestro pago si volvemos a dar clic en el botón “Execute” obtendremos los resultados correspondientes a nuestra consulta en formato JSON. Vemos que en el apartado “pagination” tenemos información que describe los resultados de nuestra consulta: podemos ver que tenemos 148 resultados en total, que estamos en la página 1, que tenemos 20 resultados por página y para nuestra conveniencia tenemos la URL de la siguiente página de resultados.

También tenemos el apartado “content” que muestra los datos de cada una de nuestras propiedades, en la imagen podemos ver la información de la propiedad con ID EB-C7705.

Al tener estos datos podemos procesarlos con cualquier lenguaje de programación que deseemos para mostrarlos a nuestros clientes en nuestro sitio web o aplicación a la medida.

Consultar los detalles de una propiedad específica

Si deseas obtener la información completa de una propiedad en específico, tendremos que usar la ruta “/properties/{property_id}”.

Cuando te despliega la sección, nuevamente da clic en el botón “Try it out” y después escribe el ID de la propiedad que deseas consultar.

Al dar clic en el botón “Execute” podrás ver como se muestra la información completa de la propiedad deseada, como es la dirección, la lista de URLs de imágenes de propiedad, etc.

Crear una solicitud de información de cliente potencial

Para llevar el registro de los clientes potenciales que solicitan información a través de tu sitio web o aplicación, puedes usar la ruta “/contact_requests”. 

Una vez que hayas entrado a este apartado, verás un ejemplo de contacto similar al de la imagen que te mostramos a continuación. Puedes notar que para usar esta ruta, la petición debe hacerse a través del método “POST”. Al dar clic en “Try it out”, puedes modificar los valores, estos valores representan los datos de contacto del cliente potencial. La solicitud de contacto se asociará a la propiedad correspondiente al “property_id” que envíes.

Después de dar clic en “Execute”, si los datos enviados tienen el formato correcto, podrás ver que tu solicitud se generó de forma correcta.

Ahora, puedes confirmar que esta solicitud de contacto, guardó un contacto nuevo en tu cuenta de EasyBroker, puedes ver que los datos corresponden a los que se enviaron a través de la API. También se agrega al historial el mensaje del cliente potencial, relacionado a la propiedad del ID enviado. Si el correo que enviaste corresponde al de un contacto ya existente, no se genera un contacto nuevo si no que se actualiza con la información que enviaste y se agrega al historial un mensaje nuevo.

Consultar la lista de ubicaciones

Si vas a utilizar la API de EasyBroker para crear tu propio sitio web, lo más probable es que quieras tener una copia de las ubicaciones con la misma estructura que tenemos en EasyBroker. En este caso puedes usar la ruta “/locations” para obtener la información.

Si no utilizas ningún criterio para tu búsqueda, la API te mostrará el país de tu cuenta y la lista de sus estados o provincias. Por ejemplo, en el caso de México verías un resultado similar al siguiente:

Si deseas conocer las ciudades de una provincia o los barrios o colonias de una ciudad sólo tienes que buscar utilizando el texto del campo “full_name”, que se crea usando el nombre de la ubicación y de sus ubicaciones padres por ejemplo “Colonia, Ciudad, Estado”. Así, si buscamos el estado de Aguascalientes, tendremos un resultado parecido a este: 

Y si buscamos la ciudad de Pabellón de Arteaga, del estado Aguascalientes, podremos ver sus colonias:

La búsqueda de ubicaciones también te puede servir si deseas hacer una importación de propiedades en EasyBroker ya que te aseguras de que los nombres de tus ubicaciones corresponderán a los que tenemos nosotros.

Ambiente de pruebas

Si aún no tienes una cuenta con nosotros o no tienes acceso a la API Key, puedes comenzar a explorar las funciones que ofrece la API con nuestro sitio de pruebas. Solo tienes que entrar a api.stagingeb.com y utilizar la API Key l7u502p8v46ba3ppgvj5y2aad50lb9. Las propiedades de esta cuenta no son propiedades reales y no están publicadas en EasyBroker por lo que puedes utilizar su información sin temores.

Esperamos que este pequeño tutorial te ayude a comenzar tu propia aplicación ¡No podemos esperar para ver qué lograrás hacer!

Si tienes algún comentario o sugerencia para mejorar nuestra API y hacerla más útil para ti, por favor avísanos escribiendo a soporte@easybroker.com.

¿Esto es lo que buscabas? ¡Muchas gracias! Hubo un problema para enviar tu retroalimentación sobre este artículo