Este herramienta está orientada a desarrolladores web y requiere algunos conocimientos básicos sobre el funcionamiento de un servicio web. Si has llegado aquí investigando cómo puedes sincronizar un servicio externo (como un portal inmobiliario) estás en el lugar correcto. Te recomiendo leer este texto con atención y dirigir tus dudas a [email protected].
A. ¿Qué son los Webhooks?
Son una herramienta que podrás utilizar para recibir, en una URL de tu elección toda la información referente a un inmueble cada vez que este cambie.
B. ¿Cómo se envía la información?
La información se enviará en una petición de tipo POST en formato JSON a una URL de tu elección que puedes configurar en Witei > Configuración > Webhooks.
Nota importante: tenemos un timeout de 15 segundos en estas peticiones. Si tu servicio no responde antes de 15 segundos a alguna petición, se reintentará 2 veces más y si aún continua el problema en tu servicio, el webhook se desactivará automáticamente, y en consecuencia, se eliminará el enlace en el apartado Webhook de Witei.
C. ¿Cómo recibo la información?
Tendrás que configurar tu servicio para escuchar peticiones de tipo POST en la URL que indicaste en Witei. Cada vez que se crees o modifiques un inmueble en Witei, enviaremos una señal (petición POST) a la URL que indicaste con toda la información del inmueble.
Ejemplo de JSON de inmueble
{
"id":43191,
"identifier":"282",
"town":"desconocido",
"province":"desconocido",
"zone":null,
"district":null,
"urbanization":"",
"street":"Zurgena",
"street_number":"",
"geo_lat":0.0,
"geo_lng":0.0,
"renting":true,
"selling":false,
"renting_cost":400,
"renting_period":"monthly",
"selling_cost":0,
"kind":"flat",
"floor":null,
"bedrooms":0,
"bathrooms":0,
"area":1,
"pictures":[
"https://witei-media.s3.amazonaws.com/pics/104418-93120cf9.JPG"
],
"description":"Bonita villa con espectaculares vistas y con 700 m2 de parcela.\\n\\n3 dormitorios, 2 ba\\u00f1os, gran cocina con lavadero. Terraza grande y porche. Garage de 100 m2. Piscina. Zona tranquila.",
"agency":{
"name":"Tu inmobiliaria",
"address":"Street type Street Name, Street number, Zip code, Town, Province, Country",
"town":"Madrid",
"zip_code":"28001",
"phone_number_1":"612345678",
"phone_number_2":"987654321-2",
"logo":"http://dev-witei.comhttps://witei-dev-media.s3.amazonaws.com/pics/glogo_iVqY4IE.gif",
"currency":"EUR",
"currency_symbol":"\\u20ac"
},
"status":"available",
"is_reserved":false,
"zip_code":"00000",
"show_cost":true,
"floor_display":null,
"area_util":null,
"area_plot":null,
"area_terrace":null,
"energy_certificate_display":"In progress",
"updated":"2018-02-27T07:50:00.209498Z",
"kind_value":"flat",
"renting_period_display":"month",
"tags":[
"garaje",
"piscina comunitaria",
"terraza"
],
"virtual_visit":null,
"description_es":"Descripción en castellano.",
"description_en":"Descripción en inglés.",
"description_ca":"Descripción en catalán.",
"description_fr":"Descripción en francés.",
"description_ru":"Descripción en ruso.",
"description_nl":"Descripción en holandés.",
"description_nb":"Descripción en noruego.",
"description_fi":"Descripción en finés.",
"description_de":"Descripción en alemán.",
"description_sv":"Descripción en sueco.",
"is_exclusive":false,
"year_built":null,
"title":null,
"contact":{
"phone":"612345678",
"name":"Tu inmobiliaria",
"email":"[email protected]"
}
}
Hay dos posibilidades de respuesta del servidor o "End Point" a estas peticiones:
Si la URL que has añadido en Witei es incorrecta, esta petición falla y por lo tanto el servidor o “End Point” devuelve una respuesta con un código de error 40X o 50X.
Por consecuencia, Witei desactiva el Webhook y avisa mediante una notificación por email al usuario.
En este caso, el usuario debe revisar qué ocurre con la URL que añadió en Witei para crear un nuevo Webhook con una URL correcta.
Si la URL que has añadido en Witei es correcta, esta petición funcionará correctamente y por lo tanto el servidor o “End Point” devolverá una respuesta de código 20X.
Nota importante: Witei acumula en ventanas de tiempo de 5 minutos todas las peticiones de Webhooks. Es decir, que si haces un cambio en un inmueble (ej: añadir una foto) pueden pasar entre mínimo 0 y máximo 5 minutos antes de que Witei envíe la petición a la URL indicada por el usuario que la ha hecho en la configuración del Webhook.
Se pueden dar casos puntuales en los que se dilata el tiempo más allá de los 5 minutos (porque haya muchos Webhooks encolados para realizar las peticiones) o que incluso un Webhook se pierda. Esto son casos marginales <0.01% de los casos y aún así son revisados por el equipo para detectar errores.
D. ¿Cómo puedo probar los webhooks?
Para que puedas hacer tus primeras pruebas, te recomendamos este servicio externo:
Es un servicio gratuito donde puedes generar una URL temporal y que se quedará "escuchando" peticiones desde sistemas remotos. Copia esa URL y pégala en tu configuración de Witei. Modifica un inmueble y en cuestión de segundos podrás ver como llega un mensaje desde Witei.
Si tienes alguna duda, ¡consúltanos por el chat!