# Propiedades
El corazón de las inmobiliarias son las propiedades, Wasi almacena información detallada de las propiedades y en esta sección veras como podrás manipularla a través de la API.
# Obtener todas las propiedades
❗️ Importante
Cuando se listan todas las propiedades se cuentan con unos filtros, ver la sección de Filtros.
Para obtener el listado de todas las propiedades en Wasi, cuentas con la URI:
api.wasi.co/v1/property/search
Esto debería retornar un JSON similar a este:
{
"total": 2,
"0": {
"id_property": 1,
"id_company": 1,
"id_user": 1,
"for_sale": "true",
"for_rent": "true",
"for_transfer": "false",
"id_property_type": 14,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindio",
"id_city": 63,
"city_label": "Armenia",
"id_location": 0,
"location_label": "",
"id_zone": 0,
"zone_label": "",
"id_currency": 1,
"iso_currency": "COP",
"name_currency": "Pesos Colombianos",
"title": "SV65850-44301",
"address": "Av/ de la peseta # 110 - 25",
"tv_share": 0,
"half_bathrooms": 1,
"area": "79",
"id_unit_area": "1",
"unit_area_label": "M2",
"built_area": "",
"id_unit_built_area": "1",
"unit_built_area_label": "M2",
"private_area": "",
"id_unit_private_area": "1",
"unit_private_area_label": "M2",
"maintenance_fee": "0",
"sale_price": "150000000",
"sale_price_label": "$150.000.000",
"rent_price": "0",
"rent_price_label": "$0",
"bedrooms": "2",
"bathrooms": "1",
"garages": "0",
"floor": "",
"observations": "Aqui las observaciones del ejemplo 1",
"video": "https:\/\/vimeo.com\/88462167",
"id_property_condition": "2",
"property_condition_label": "Used",
"id_status_on_page": "3",
"status_on_page_label": "Outstanding",
"map": "",
"latitude": "",
"longitude": "",
"building_date": "",
"network_share": false,
"visits": 79,
"created_at": "2015-09-07 16:22:45",
"updated_at": "2016-04-06 14:40:01",
"reference": "",
"comment": "",
"id_rents_type": "4",
"rents_type_label": "Monthly",
"zip_code": "",
"id_availability": "2",
"availability_label": "Sold",
"id_publish_on_map": "1",
"publish_on_map_label": "Do not post",
"main_image": {
"id_gallery": "112861",
"id_image": "4096458",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo13.jpg",
"description": "",
"position": "1"
},
"galleries": [
{
"id": "112861",
"0": {
"id": "4096458",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo15.jpg",
"description": "",
"position": "1"
},
"1": {
"id": "4096459",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo16.jpg",
"description": "",
"position": "2"
},
"2": {
"id": "4096460",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdGF0aWNiIiwia2V5IjoiaW5tdWVibGVzXC9iN",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo17.jpg",
"description": "",
"position": "3"
}
}
],
"features": {
"internal": [
{
"id": "84",
"nombre": "Armarios empotrados",
"name": ""
},
{
"id": "5",
"nombre": "Balcón",
"name": ""
}
],
"external": [
{
"id": "78",
"nombre": "Área social",
"name": ""
}
]
},
"label": "Parque central",
"owner": "own"
},
"1": {
"id_property": 2,
"id_company": 1,
"id_user": 1,
"for_sale": "true",
"for_rent": "true",
"for_transfer": "false",
"id_property_type": 7,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindio",
"id_city": 129,
"city_label": "Calarca",
"id_location": 0,
"location_label": "",
"id_zone": 22170,
"zone_label": "Vereda",
"id_currency": 1,
"iso_currency": "COP",
"name_currency": "Pesos Colombianos",
"title": "Finca en venta El Paraiso, Vereda Floresta Calarca",
"address": "Finca el Paraiso, vereda la Floresta. Calarca, Quindio",
"tv_share": 0,
"half_bathrooms": 0,
"area": "6400",
"id_unit_area": "1",
"unit_area_label": "M2",
"built_area": "",
"id_unit_built_area": "1",
"unit_built_area_label": "M2",
"maintenance_fee": "0",
"sale_price": "289000000",
"sale_price_label": "$289.000.000",
"rent_price": "0",
"rent_price_label": "$0",
"bedrooms": "4",
"bathrooms": "1",
"garages": "1",
"floor": "Rural",
"furnished": "false",
"observations": "Aqui las observaciones del ejemplo 2",
"video": "",
"id_property_condition": "2",
"property_condition_label": "Used",
"id_status_on_page": "3",
"status_on_page_label": "Outstanding",
"map": "4.529195895731443,-75.63777923583984",
"latitude": "4.529195895731443",
"longitude": "-75.63777923583984",
"building_date": "",
"network_share": true,
"visits": 404,
"created_at": "2015-07-08 07:39:18",
"updated_at": "2015-08-12 11:25:50",
"reference": "",
"comment": "",
"id_rents_type": "4",
"rents_type_label": "Monthly",
"zip_code": "630001",
"id_availability": "1",
"availability_label": "Available",
"id_publish_on_map": "1",
"publish_on_map_label": "Do not post",
"main_image": {
"id_gallery": "105232",
"id_image": "4052247",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo18.jpg",
"description": "",
"position": "1"
},
"galleries": [
{
"id": "105232",
"0": {
"id": "4052247",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo22.jpg",
"description": "",
"position": "1"
},
"1": {
"id": "4052248",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo24.jpg",
"description": "",
"position": "2"
},
"2": {
"id": "4052249",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo26.jpg",
"description": "",
"position": "3"
}
}
],
"features": {
"internal": [
{
"id": "2",
"nombre": "Alarma",
"name": ""
},
{
"id": "4",
"nombre": "Amoblado",
"name": ""
}
],
"external": [
{
"id": "53",
"nombre": "Árboles frutales",
"name": ""
}
]
},
"label": "",
"owner": "own"
},
"status": "success"
}
El campo owner en el JSON de respuesta indica si la propiedad obtenida es propia (own) o de una empresa aliada (allied).
❗️ Importante
Si se envía el parametro short con valor true retorna una versión reducida de la propiedad, sin el listado de Galerías y Características. Estos listado se pueden obtener de forma independiente como esta indicado en Galerías de la propiedad, y Características de la propiedad.
# Obtener una propiedad
Para obtener una propiedad en Wasi, cuentas con la URI:
api.wasi.co/v1/property/get/#id_property
Para una propiedad de ejemplo cuyo id_property es 1, la URI sería:
api.wasi.co/v1/property/get/1
Esto debería retornar un JSON similar a este:
{
"id_property": 1,
"id_company": 1,
"id_user": 1,
"for_sale": "true",
"for_rent": "true",
"for_transfer": "false",
"id_property_type": 14,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindio",
"id_city": 63,
"city_label": "Armenia",
"id_location": 0,
"location_label": "",
"id_zone": 0,
"zone_label": "",
"id_currency": 1,
"iso_currency": "COP",
"name_currency": "Pesos Colombianos",
"title": "SV65850-44301",
"address": "Av/ de la peseta # 110 - 25",
"tv_share": 0,
"half_bathrooms": 1,\
"area": "79",
"id_unit_area": "1",
"unit_area_label": "M2",
"built_area": "",
"id_unit_built_area": "1",
"unit_built_area_label": "M2",
"private_area": "",
"id_unit_private_area": "1",
"unit_private_area_label": "M2",
"maintenance_fee": "0",
"sale_price": "150000000",
"sale_price_label": "$150.000.000",
"rent_price": "0",
"rent_price_label": "$0",
"bedrooms": "2",
"bathrooms": "1",
"garages": "0",
"floor": "",
"observations": "Aqui las observaciones del ejemplo 1",
"video": "https:\/\/vimeo.com\/88462167",
"id_property_condition": "2",
"property_condition_label": "Used",
"id_status_on_page": "3",
"status_on_page_label": "Outstanding",
"map": "",
"latitude": "",
"longitude": "",
"building_date": "",
"network_share": false,
"visits": 79,
"created_at": "2015-09-07 16:22:45",
"updated_at": "2016-04-06 14:40:01",
"reference": "",
"comment": "",
"id_rents_type": "4",
"rents_type_label": "Monthly",
"zip_code": "",
"id_availability": "2",
"availability_label": "Sold",
"id_publish_on_map": "1",
"publish_on_map_label": "Do not post",
"main_image": {
"id_gallery": "112861",
"id_image": "4096458",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo12.jpg",
"description": "",
"position": "1"
},
"galleries": [
{
"id": "112861",
"0": {
"id": "4096458",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo12.jpg",
"description": "",
"position": "1"
},
"1": {
"id": "4096459",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo14.jpg",
"description": "",
"position": "2"
},
"2": {
"id": "4096460",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo16.jpg",
"description": "",
"position": "3"
}
}
],
"features": {
"internal": [
{
"id": "2",
"nombre": "Alarma",
"name": ""
},
{
"id": "4",
"nombre": "Amoblado",
"name": ""
},
{
"id": "84",
"nombre": "Armarios empotrados",
"name": ""
},
{
"id": "5",
"nombre": "Balcón",
"name": ""
}
],
"external": [
{
"id": "53",
"nombre": "Árboles frutales",
"name": ""
},
{
"id": "78",
"nombre": "Área social",
"name": ""
}
]
},
"label": "Parque central",
"owner": "own",
"status": "success"
}
El campo owner en el JSON de respuesta indica si la propiedad obtenida es propia (own) o de una empresa aliada (allied), en el caso de una empresa aliada la respuesta cambia agregando la información de la cuenta aliada, esto debería retornar un JSON similar a este:
{
"id_property": 111983,
"id_company": 604698,
"id_user": 9,
"for_sale": "true",
"for_rent": "false",
"for_transfer": "false",
"for_temporary_rent": "false",
"id_property_type": 2,
"id_country": 81,
"country_label": "Chile",
"id_region": 1664,
"region_label": "Antofagasta",
"id_city": 439689,
"city_label": "Aguada de Cachinal",
"id_location": 0,
"location_label": "",
"id_zone": 0,
"zone_label": "",
"id_currency": 8,
"iso_currency": "CLP",
"name_currency": "Pesos Chilenos",
"title": "Va783-Hermosa casa en el campo \"no existe\"",
"address": "NOT_AUTHORIZED",
"tv_share": 0,
"half_bathrooms": 0,
"area": "0",
"id_unit_area": "1",
"unit_area_label": "M2",
"built_area": "0",
"id_unit_built_area": "1",
"unit_built_area_label": "M2",
"private_area": "0",
"id_unit_private_area": "1",
"unit_private_area_label": "M2",
"maintenance_fee": "0",
"maintenance_fee_label": "$0",
"sale_price": "195000",
"sale_price_label": "$195.000",
"rent_price": "0",
"rent_price_label": "$0",
"bedrooms": "0",
"bathrooms": "0",
"garages": "0",
"floor": "",
"stratum": "7",
"observations": "",
"video": "https://www.youtube.com/watch?v=c9usCfFIgPs",
"id_property_condition": "2",
"property_condition_label": "Usado",
"map": "4.494092965507051,-75.69876194000244",
"latitude": "4.494092965507051",
"longitude": "-75.69876194000244",
"building_date": "2012",
"created_at": "2015-08-05 21:50:27",
"updated_at": "2015-08-13 10:54:35",
"reference": "",
"id_rents_type": "4",
"rents_type_label": "Mensual",
"zip_code": "",
"id_label": 31,
"label": "Guille",
"label_color": "#3d85c6",
"main_image": {
"id_gallery": 110790,
"id_image": 4064810,
"url": "https://d3i552gu3ueuex.cloudfront.neteyJidWNrZXQiOiJzdGF0aWNiIiwia2V5IjoiaW5tdWVibGVzXC9iMjYwNTEyMDE1MDgwNTA5NTA0NC5qcGciLCJlZGl0cyI6eyJub3JtYWxpc2UiOnRydWUsInJvdGF0ZSI6MCwicmVzaXplIjp7IndpZHRoIjo1NTUsImhlaWdodCI6NDE2LCJmaXQiOiJjb250YWluIiwiYmFja2dyb3VuZCI6eyJyIjoyNTUsImciOjI1NSwiYiI6MjU1LCJhbHBoYSI6MX19fX0=",
"url_original": "https://staticb.s3.amazonaws.com/inmuebles/2605120150805095044.jpg",
"description": "",
"filename": "2605120150805095044.jpg",
"position": 1,
"url_big": "https://d3i552gu3ueuex.cloudfront.neteyJidWNrZXQiOiJzdGF0aWNiIiwia2V5IjoiaW5tdWVibGVzXC9iMjYwNTEyMDE1MDgwNTA5NTA0NC5qcGciLCJlZGl0cyI6eyJub3JtYWxpc2UiOnRydWUsInJvdGF0ZSI6MCwicmVzaXplIjp7IndpZHRoIjo5NzksImhlaWdodCI6NzQzLCJmaXQiOiJjb250YWluIiwiYmFja2dyb3VuZCI6eyJyIjoyNTUsImciOjI1NSwiYiI6MjU1LCJhbHBoYSI6MX19fX0="
},
"registration_number": "",
"id_status_on_page": "1",
"status_on_page_label": "Activo",
"id_publish_on_map": "3",
"publish_on_map_label": "Publicar punto exacto",
"network_share": false,
"visits": 57,
"comment": "",
"id_availability": "1",
"availability_label": "Disponible",
"owner": "allied",
"company": {
"name": "iFer Propiedades",
"company_id": 604698,
"email": "[email protected]",
"cellphone": "3182801293",
"phone": "74755859"
},
"link": "https://rr.inmo.co/apartamento-venta-aguada-de-cachinal/111983",
"url_360": "",
"status": "success"
}
❗️ Importante
Si se envía el parametro short con valor true retorna una versión reducida de la propiedad, sin el listado de Galerías y Características. Estos listado se pueden obtener de forma independiente como esta indicado en Galerías de la propiedad, y Características de la propiedad.
# Filtrado adicional
Aplican opciones de filtrado definidas en Galerías de imágenes de la propiedad.
# Filtrado
Todos los filtros son opcionales, a continuación se listan los filtros exitentes para la búsqueda de propiedades, ver la sección de Obtener todas las propiedades.
| Filtro | Tipo | Detalle |
|---|---|---|
| match | String | Palabras claves para realizar una busqueda. |
| id_property | Number | Id de la propiedad. |
| id_user | Number | Id del usuario asociado a la propiedad. |
| title | String | Título parcial o completo de la propiedad. |
| id_country | Number | Id de un país, ver Paises. |
| id_region | Number | Id de una región, ver Regiones. |
| id_city | Number | Id de una ciudad, ver Ciudades. |
| id_location | Number | Id de una localidad, ver Localidades. |
| id_zone | Number | Id de una zona, ver Zonas. |
| id_property_type | Number | Id del tipo de propiedad, ver Tipos de propiedad |
| for_sale | Boolean | Inmueble en venta |
| for_rent | Boolean | Inmueble esta diponible para la renta |
| for_transfer | Boolean | Inmueble esta diponible para permutar(transferencia). |
| min_bedrooms | Number | Número mínimo de habitaciones de la propiedad |
| max_bedrooms | Number | Número máximo de habitaciones de la propiedad |
| bathrooms | Number | Número mínimo de baños de la propiedad |
| garages | Number | Número mínimo de garajes de la propiedad |
| id_status_on_page | Number | Id del estado de la propiedad, ver Estado en la página. |
| id_availability | Number | Id de la disponibilidad de la propiedad, ver Disponibilidad. |
| id_property_condition | Number | Id de la condición de la propiedad, ver la sección Condiciones de la propiedad. |
| building_date | Number | Año de construcción mínimo de la propiedad. |
| min_price | Number | Precio mínimo de la propiedad. |
| max_price | Number | Precio máximo de la propiedad. |
| min_private_area | Number | Área privada mínima de la propiedad. |
| max_private_area | Number | Área privada máxima de la propiedad. |
| min_built_area | Number | Área construida mínima de la propiedad. |
| max_built_area | Number | Área construida máxima de la propiedad. |
| min_area | Number | Área mínima de la propiedad. |
| max_area | Number | Área máxima de la propiedad. |
| scope | Number | Indica si se listan las propiedades propias o de los aliados, ver scope |
| short | Boolean | Si se envía como true no se muestra en la respuesta los listados de Galerías y Características |
Es posible fitrar inmuebles en varias zonas, para ello en la propiedad id_zone se deben agregar los Id de las zonas separados por coma ( , ).
❗️ Importante
Si se envía el parametro short con valor true retorna una versión reducida de la propiedad, sin el listado de Galerías y Características. Estos listado se pueden obtener de forma independiente como esta indicado en Galerías de la propiedad, y Características de la propiedad.
# Filtrado adicional
Aplican opciones de filtrado definidas en Galerías de imágenes de la propiedad.
| Filtro | Tipo | |
|---|---|---|
| lax_business_type | Boolean | El valor de lax_business_type es false por defecto. Cuando lax_business_type es true, se listan los inmuebles que cumplan con al menos uno de los filtros de tipo de negocio (for_sale, for_rent, for_transfer) enviados como true. Cuando lax_business_type es false se listan los inmuebles que cumplan todos los filtros de tipo de negocio (for_sale, for_rent, for_transfer) enviados como true. |
# Paginación y ordenamiento
| Filtro | Tipo | |
|---|---|---|
| skip | Number | Offset, indica desde donde se muestran los registros, 0 por defecto (desde el inicio, sin omitir ninguno). |
| take | Number | Limit, cantidad de elementos a listar, 10 por defecto (100 como máximo). |
| order | String | Puede tomar dos valores asc (Ascendente) y desc (Descendente), desc por omisión. |
| order_by | String | Ordena por una criterio en específico, id_property por omisión ver order_by. |
# order_by
| Valor | Descripción |
|---|---|
| id_property | Ordena las propiedades por id. |
| title | Ordena las propiedades por título. |
| id_country | Ordena las propiedades por país. |
| id_region | Ordena las propiedades por región. |
| id_city | Ordena las propiedades por ciudad. |
| id_property_type | Ordena las propiedades por tipo. |
| id_business_type | Ordena las propiedades segun su tipo de negocio. |
| sale_price | Ordena las propiedades por su precio de venta. |
| rent_price | Ordena las propiedades por su precio de renta. |
| visits | Ordena las propiedades por su número de visitas. |
| id_status_on_page | Ordena las propiedades por estado, ver Estado en la página. |
| created_at | Ordena las propiedades por fecha de registro. |
| max_price | Ordena las propiedades por precio de mayor a menor. |
| min_price | Ordena las propiedades por precio de menor a mayor. |
# Scope
| Valor | Representa |
|---|---|
| 1 | Privado, lista sólo las propiedades creadas por la empresa. |
| 2 | Aliados, lista sólo las propiedades activas de empresas aliadas. |
| 3 | Todas, lista propiedades privadas y propiedades activas de empresas aliadas. (opción por defecto) |
| 4 | Grupo, sólo cuenta las propiedades activas en los grupos. |
# Agregar una propiedad
Para agregar una nueva propiedad en Wasi, cuentas con la URI:
api.wasi.co/v1/property/add
Para saber cuales son los parametros que se deben enviar se puede ver la sección Campos de las propiedades, los campos que podemos envíar como parámetro en la tabla deben figurar como modificables.
Despues de enviar los parametros correctamente debería devolver un JSON como el siguiente:
{
"id_property": 123456,
"status": "success"
}
❗️ Importante
Los parametros pueden enviarse via GET o via POST, asi como es de recordar que para todas las peticiones también es necesario envíar las credenciales de acceso, ver Credenciales de acceso.
❗️ Nota
Una vez creado el inmueble este se envía automáticamente a los portales aliados asignados en el campo portals.
# Actualizar propiedad
Para actualizar una propiedad en Wasi, cuentas con la URI:
api.wasi.co/v1/property/update/#id_property
Para una propiedad de ejemplo cuyo id_property es 1, la URI sería:
api.wasi.co/v1/property/update/1
Para saber cuales son los campos que se pueden actualizar se puede ver la sección Campos de las propiedades, los campos que podemos envíar como parámetro en la tabla deben figurar como modificables.
Por ejemplo si se desea cambiar el agente con id_user 1 por el agente con id_user 2 de la propiedad con id_property 3, debe hacer lo siguiente:
api.wasi.co/v1/property/update/3?id_user=2
Deberia devolver un JSON como el siguiente:
{
"status": "success"
}
❗️ Importante
Los parametros a modificar pueden enviarse via GET o via POST, asi como es de recordar que para todas las peticiones también es necesario envíar las credenciales de acceso, ver Credenciales de acceso.
❗️ Nota
Una vez actualizado el inmueble este se envía automáticamente a los portales aliados asignados en el campo portals.
# Subir una imagen
Para subir una imagen de una propiedad en Wasi, cuentas con la URI:
api.wasi.co/v1/property/upload-image/#id_property
Para subir una imagen a la propiedad de ejemplo cuyo id_property es 1, la URI seria:
api.wasi.co/v1/property/upload-image/1
La imagen (file) debe enviarse en el parametro llamado image, los formatos soportados son PNG, JPEG, JPG y GIF. En la siguiente tabla se listan los parametros soportados por la URI de subida de imagenes:
| Parametro | Tipo | Descripción |
|---|---|---|
| image | File | Es el archivo que se envia desde un form html (PNG, JPEG, JPG y GIF) que se desea subir |
| description | String | Descripción de la imagen. Para indicar que es una imagen 360 se debe enviar el valor "spherical" |
| position | Number | Indica la posición de la imagen con respecto a las demas |
❗️ Importante
La imagenes pueden subirse usando la api desde un form html o tambien subir imagenes que estan previamente alojadas en un servidor a continuación se muestra como podria hacerse desde PHP (usando cURL).
$path = realpath('./img/foto1234.png');
$post = ['image' => new \CURLFile($path, 'text/plain', 'foto1234.png')];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'http://api.wasi.co/v1/property/upload-image/1234?id_company=1234&wasi_token=mi_token');
curl_setopt($ch, CURLOPT_POST,1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);
$result=curl_exec ($ch);
curl_close ($ch);
# Actualizar en portales
Si desea actualizar las imágenes del inmueble en los portales aliados, puede hacer una solicitud adicional a la URI:
api.wasi.co/v1/portal/send-property/#id_property
# Actualizar datos de una imagen
Para actualizar los datos de una imagen de una propiedad en Wasi, cuentas con la URI:
api.wasi.co/v1/gallery/image/update-data/#id_image
Para actualizar los datos de una imagen de ejemplo cuyo id_image es 1 y pertenece a la propiedad 2, la URI seria:
api.wasi.co/v1/gallery/image/update-data/1?id_property=2
En la siguiente tabla se listan los parametros soportados por la URI:
| Parametro | Tipo | Descripción |
|---|---|---|
| id_property | Int | Identificador de la propiedad a la que pertenece la imagen. Obligatorio |
| description | String | Descripción de la imagen. Para indicar que es una imagen 360 se debe enviar el valor "spherical" |
| position | Number | Indica la posición de la imagen con respecto a las demas |
❗️ Importante
Los parametros a modificar pueden enviarse via GET o via POST, asi como es de recordar que para todas las peticiones también es necesario envíar las credenciales de acceso, ver Credenciales de acceso.
# Eliminar una imagen
Para eliminar una imagen de una propiedad en Wasi, cuentas con la URI:
POST api.wasi.co/v1/property/remove-image/#id_property?id=#id_image
Si todo esta en orden, esto debería retornar un JSON similar al siguiente:
{
"status": "success"
}
❗️ Importante
La petición debe enviarse via POST, asi como es de recordar que para todas las peticiones también es necesario envíar las credenciales de acceso, ver Credenciales de acceso.
# Cambiar/Eliminar etiqueta
# Cambiar etiqueta
Puedes cambiar la etiqueta de una propiedad con la URI:
POST api.wasi.co/v1/property/change-label/#id_property
Debes enviar el identificador de la etiqueta.
# Parámetros
| Nombre | Tipo | Detalle |
|---|---|---|
| id_label | Number | Id de la etiqueta, ver Etiquetas para propiedades. |
Si todo esta en orden, esto debería retornar un JSON similar al siguiente:
{
"status": "success"
}
# Eliminar etiqueta
Si deseas eliminar la etiqueta de la propiedad puedes usar la URI:
POST api.wasi.co/v1/property/remove-label/#id_property
Si todo esta en orden, esto debería retornar un JSON similar al siguiente:
{
"status": "success"
}
❗️ Importante
Para todas las peticiones es necesario el envío de credenciales, para más información puedes visitar la sección de Primeros pasos.
# Tipos de propiedad
Para obtener el listado de todos los tipos de propiedad soportados por Wasi se debe usar la URI:
api.wasi.co/v1/property-type/all
Esto debería retornar un JSON similar al siguiente:
{
"0": {
"id_property_type": "1",
"name": "",
"nombre": "Casa"
},
"1": {
"id_property_type": "2",
"name": "",
"nombre": "Apartamento"
},
"2": {
"id_property_type": "3",
"name": "",
"nombre": "Local"
},
"status": "success"
}
# Cantidades por Tipo de propiedad
La API de Wasi permite obtener la cantidad de inmuebles con base en su tipo (adicionando la variable quantity). Dicha URI recibe los siguientes parametros:
| Nombre | Tipo | |
|---|---|---|
| quantity | Boolean | Valor booleano (true o false) obligatoria para obtener la cantidad de inmuebles con base en su tipo. |
| for_sale | Boolean | Valor booleano (true o false) que indica si los inmuebles estan diponibles para la venta o no. |
| for_rent | Boolean | Valor booleano (true o false) que indica si los inmuebles estan diponibles para la renta (alquilar, arrendar) o no. |
| for_transfer | Boolean | Valor booleano (true o false) que indica si el inmuebles estan disponibles para permutar. |
| id_country | Number | Identificador del país de las propiedades, ver la sección Paises. |
| id_region | Number | Identificador de la región de las propiedades, ver la sección Regiones. |
| id_city | Number | Identificador de la ciudad de la propiedad, ver la sección Ciudades. |
| id_location | Number | Identificador de la localidad de la propiedad, ver la sección Localidades. |
| scope | Number | Indica si la cantidad se obtiene contando las propiedades propias o de los aliados, ver scope. |
# Scope
| Valor | Representa |
|---|---|
| 1 | Privado, sólo cuenta las propiedades creadas por la empresa. |
| 2 | Aliados, sólo cuenta las propiedades activas de empresas aliadas. |
| 3 | Todas, cuenta propiedades privadas y propiedades activas de empresas aliadas. (opción por defecto) |
| 4 | Grupo, sólo cuenta las propiedades activas en los grupos. |
Para obtener las cantidades en general puede usarse:
api.wasi.co/v1/location/all-countries?quantity=true
Si se quiere ver especificamente la cantidad de propiedades en una Zona con el código hipotético 123, quedaría asi:
api.wasi.co/v1/property-type/all?quantity=true&id_zone=123
Si se quiere ver especificamente la cantidad de propiedades en la ciudad Armenia (Código 63), quedaría asi:
api.wasi.co/v1/property-type/all?quantity=true&id_city=63
Si se quiere ver especificamente la cantidad de propiedades en la localidad Chapinero (Código 1), quedaría asi:
api.wasi.co/v1/property-type/all?quantity=true&id_location=1
Si se quiere ver especificamente la cantidad de propiedades en la región Quindío (Código 26), quedaría asi:
api.wasi.co/v1/property-type/all?quantity=true&id_region=26
Si se quiere ver especificamente la cantidad de propiedades en el país Colombia (Código 1), quedaría asi:
api.wasi.co/v1/property-type/all?quantity=true&id_country=1
Si se quiere ver el tipo de negocio, por ejemplo para la venta o permuta en Colombia (Código 1), quedaría asi:
api.wasi.co/v1/property-type/all?quantity=true&for_sale=true&for_transfer=true&id_country=1
Si se quiere ver el tipo de negocio, por ejemplo para la venta que sean de empresas aliadas, quedaría asi:
api.wasi.co/v1/property-type/all?quantity=true&for_sale=true&scope=2
❗️ Importante
En el caso de enviar juntos varios criterios de ubicación, se tomara unicamente el valor mas atómico, es decir, primero id_zone, de no existir id_location, de no existir id_city, de no existir id_region y finalmente si no existe ninguno de los anteriores el criterio sería id_country.
Es posible fitrar inmuebles en varias zonas, para ello en la propiedad id_zone se deben agregar los Id de las zonas separados por coma ( , ).
Estos casos deberian retornar un JSON similar al siguiente:
{
"0": {
"id_property_type": "1",
"name": "",
"nombre": "Casa",
"quantity": 15
},
"1": {
"id_property_type": "2",
"name": "",
"nombre": "Apartamento",
"quantity": 10
},
"2": {
"id_property_type": "3",
"name": "",
"nombre": "Local",
"quantity": 1
},
"status": "success"
}
❗️ Importante
Para todas las peticiones es necesario el envío de credenciales, para más información puedes visitar la sección de Primeros pasos.
# Rango de precios
La API de Wasi permite obtener de manera simple los máximos y mínimos de los precios en cuanto al precio para venta como alquiler/arriendo/renta de todos los inmuebles, para ello se cuenta con la URI:
api.wasi.co/v1/property/price-range
Esto debería retornar un JSON similar a este:
{
"max_sale_price":"450000000",
"min_sale_price":"200000000",
"max_rent_price":"1900000",
"min_rent_price":"450000",
"status":"success"
}
| Nombre | Representa |
|---|---|
| max_sale_price | Es el valor máximo encontrado en el precio de venta de los inmuebles propios o de los aliados. |
| min_sale_price | Es el valor mínimo encontrado en el precio de venta de los inmuebles propios o de los aliados. |
| max_rent_price | Es el valor máximo encontrado en el precio de alquiler/arriendo/renta de los inmuebles propios o de los aliados. |
| min_rent_price | Es el valor mínimo encontrado en el precio de alquiler/arriendo/renta de los inmuebles propios o de los aliados. |
# Rango de áreas
La API de Wasi permite obtener de manera simple los máximos y mínimos de las áreas de todos los inmuebles, para ello se cuenta con la URI:
api.wasi.co/v1/property/area-range
Esto debería retornar un JSON similar a este:
{
"max_private_area": "55",
"min_private_area": "",
"max_built_area": "65",
"min_built_area": "",
"max_area": "110",
"min_area": "",
"status": "success"
}
| Nombre | Representa |
|---|---|
| max_private_area | Es el valor máximo encontrado en el área privada de los inmuebles propios o de los aliados. |
| min_private_area | Es el valor mínimo encontrado en el área privada de los inmuebles propios o de los aliados. |
| max_built_area | Es el valor máximo encontrado en el área construida de los inmuebles propios o de los aliados. |
| min_built_area | Es el valor mínimo encontrado en el área construida de los inmuebles propios o de los aliados. |
| max_area | Es el valor máximo encontrado en el área de los inmuebles propios o de los aliados. |
| min_area | Es el valor mínimo encontrado en el área de los inmuebles propios o de los aliados. |
# Cantidades por Tipo de negocio
La API de Wasi permite obtener de manera simple el total de inmuebles según el tipo de negocio y la ubicación de los mismos, para ello se cuenta con la URI:
api.wasi.co/v1/property-business-type/quantity
Dicha URI recibe los siguientes parametros:
| Nombre | Tipo | |
|---|---|---|
| for_sale | Boolean | Valor booleano (true o false) que indica si los inmuebles estan diponibles para la venta o no. |
| for_rent | Boolean | Valor booleano (true o false) que indica si los inmuebles estan diponibles para la renta (alquilar, arrendar) o no. |
| for_transfer | Boolean | Valor booleano (true o false) que indica si el inmuebles estan disponibles para permutar. |
| id_country | Number | Identificador del país de las propiedades, ver la sección Paises. |
| id_region | Number | Identificador de la región de las propiedades, ver la sección Regiones. |
| id_city | Number | Identificador de la ciudad de la propiedad, ver la sección Ciudades. |
| id_location | Number | Identificador de la localidad de la propiedad, ver la sección Localidades. |
| id_zone | Number | Identificador de la localidad de la propiedad, ver la sección Zonas. |
| scope | Number | Indica si la cantidad se obtiene contando las propiedades propias o de los aliados, ver scope |
Es posible fitrar inmuebles en varias zonas, para ello en la propiedad id_zone se deben agregar los Id de las zonas separados por coma ( , ).
# Scope
| Valor | Representa |
|---|---|
| 1 | Privado, sólo cuenta las propiedades creadas por la empresa. |
| 2 | Aliados, sólo cuenta las propiedades activas de empresas aliadas. |
| 3 | Todas, cuenta propiedades privadas y propiedades activas de empresas aliadas. (opción por defecto) |
| 4 | Grupo, sólo cuenta las propiedades activas en los grupos. |
❗️ Importante
Debe indicarse al menos una de las 3 variables booleanas (for_sale, for_rent, for_transfer) como true, las variables que hacen referencia a la ubicación son opcionales.
Por ejemplo para solicitar el total de inmuebles para la venta o permuta en Colombia se puede hacer de la siguiente manera:
api.wasi.co/v1/property-business-type/quantity?for_sale=true&for_transfer=true&id_country=1
Esto debería retornar un JSON similar a este:
{
"quantity": 28,
"status": "success"
}
# Publicación en mapas de Google
Las propiedades latitude y longitude se modifican para almacenar las coordenadas de Google maps, estas pueden tomar valores como por ejemplo::
latitude: 4.5666285875039145
longitude: -75.74845790863037
La propiedad map de solo lectura (se obtiene al consultar propiedades) almacena un String con las coordenadas de Google maps (latitude y longitude) separadas por una coma, por ejemplo estos 3 posibles valores::
4.5666285875039145,-75.74845790863037
4.467523992463404,-75.76628923416138
9.168449747185411,-79.57414627075195
# Galerías de imágenes
Las galerias dentro del JSON de la propiedad siguen la siguiente estructura:
[
{
"id": "1",
"0": {
"id": "1",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo8.jpg",
"description": "",
"position": "1"
},
"1": {
"id": "2",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo9.jpg",
"description": "",
"position": "2"
},
"2": {
"id": "3",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo10.jpg",
"description": "",
"position": "3"
}
},
{
"id": "2",
"0": {
"id": "4",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo12.jpg",
"description": "",
"position": "1"
},
"1": {
"id": "5",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo14.jpg",
"description": "",
"position": "2"
},
"2": {
"id": "6",
"url": "https:\/\/images.wasi.co\/inmuebles\/ejemplo15.jpg",
"url_big": "https:\/\/images.wasi.co\/inmuebles\/ejemplo16.jpg",
"description": "",
"position": "3"
}
}
]
❗️ Importante
Si el campo description tiene asignado el valor spherical indica que la imágen es 360, esto puede ayudar a que la imágen sea mostrada de forma correcta.
# Obtener galerias de una propiedad
Para obtener todas las galerias de una propiedad, existe la siguiente URI:
http://api.wasi.co/v1/gallery/all/#id_property
Esto debería retornar un JSON similar al siguiente:
{
"0": {
"id_gallery": 1,
"id_property": 1
},
"total": 1,
"status": "success"
}
Para obtener todas las imagenes de una galería de forma independiente a la consulta de propiedad, existe la siguiente URI:
http://api.wasi.co/v1/gallery/image/all/#id_gallery
Esto debería retornar un JSON similar al siguiente:
{
"0": {
"id_image": 1,
"url": "https://images.wasi.co/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https://images.wasi.co/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https://images.wasi.co/inmuebles/gr_imagen1.jpg",
"description": "",
"filename": "gr_imagen1.jpg",
"position": 1
},
"1": {
"id_image": 2,
"url": "https://images.wasi.co/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https://images.wasi.co/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https://images.wasi.co/inmuebles/gr_imagen2.jpg",
"description": "",
"filename": "gr_imagen2.jpg",
"position": 2
},
"2": {
"id_image": 3,
"url": "https://images.wasi.co/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https://images.wasi.co/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https://images.wasi.co/inmuebles/gr_imagen3.jpg",
"description": "",
"filename": "gr_imagen3.jpg",
"position": 3
},
"id_gallery": 1,
"status": "success"
}
# Filtrado
A continuación se listan los filtros exitentes para el tipo de imagen.
| Filtro | Tipo | Detalle |
|---|---|---|
| size | String | Tamaño de la imagen, acepta las opciones: small, big, giant |
| watermark | Boolean | Imagen con marca de agua true, o sin marca de agua false. |
# Características
Al crear o editar una propiedad se puede enviar un array con los ids de las características en el parametro features, por ejemplo si se quiere actualizar la propiedad con id 1234, para que tenga las características con id 2 y 4, podemos enviar este parametro tanto via URL como JSON y seria algo asi en el primer caso:
http://api.wasi.co/v1/property/update/1234?features[]=2&features[]=4
❗️ Importante
El array de características es opcional, sin embargo cuando se envia será validado, si se esta actualizando una propiedad y no se envía el array se conservaran los valores existentes, si se envía un nuevo array sustituira el previo.
# Ver características de una propiedad
Las características dentro del JSON al consultar una propiedad siguen la siguiente estructura:
"features": {
"internal": [
{
"id": "2",
"nombre": "Alarma",
"name": "",
"own": false
},
{
"id": "4",
"nombre": "Amoblado",
"name": "",
"own": false
},
{
"id": "84",
"nombre": "Armarios empotrados",
"name": "",
"own": false
},
{
"id": "5",
"nombre": "Balcón",
"name": "",
"own": false
},
{
"id": "6",
"nombre": "Característica personalizada",
"name": "",
"own": true
}
],
"external": [
{
"id": "53",
"nombre": "Árboles frutales",
"name": "",
"own": false
},
{
"id": "78",
"nombre": "Área social",
"name": "",
"own": false
}
]
},
# Obtener todas las características
Para obtener todas las características soportadas por Wasi, existe la siguiente URI:
http://api.wasi.co/v1/feature/all
Esto debería retornar un JSON que agrupa las características según si son internas o externas similar al siguiente:
{
"internal": [
{
"id": "1",
"nombre": "Aire acondicionado",
"name": "",
"own": false
},
{
"id": "2",
"nombre": "Alarma",
"name": "",
"own": false
},
{
"id": "4",
"nombre": "Amoblado",
"name": "",
"own": false
},
{
"id": "6",
"nombre": "Característica personalizada",
"name": "",
"own": true
}
],
"external": [
{
"id": "25",
"nombre": "Cancha de squash",
"name": "",
"own": false
},
{
"id": "26",
"nombre": "Cancha de tenis",
"name": "",
"own": false
},
{
"id": "27",
"nombre": "Zonas deportivas",
"name": "",
"own": false
}
],
"status": "success"
}
# Filtro
| Filtro | Tipo | Detalle |
|---|---|---|
| type | String | Puede tomar dos valores internal y external. |
| list | Boolean | Indica si se muestra la respuesta en un listado sin separación por tipo. |
Si se envía el parametro list con valor true las características se muestran en un arreglo unico, con el formato siguiente:
{
"0": {
"id": 1,
"nombre": "Aire acondicionado",
"name": "",
"type": "Internal",
"own": false
},
"1": {
"id": 2,
"nombre": "Alarma",
"name": "",
"type": "Internal",
"own": false
},
"2": {
"id": 4,
"nombre": "Amoblado",
"name": "",
"type": "Internal",
"own": false
},
"23": {
"id": 25,
"nombre": "Cancha de squash",
"name": "",
"type": "External",
"own": false
},
"24": {
"id": 26,
"nombre": "Cancha de tenis",
"name": "",
"type": "External",
"own": false
},
"25": {
"id": 27,
"nombre": "Zonas deportivas",
"name": "",
"type": "External",
"own": false
},
"26": {
"id": 28,
"nombre": "Gimnasio",
"name": "",
"type": "External",
"own": false
},
"27": {
"id": 29,
"nombre": "Jardín",
"name": "",
"type": "External",
"own": false
},
"28": {
"id": 30,
"nombre": "Patio",
"name": "",
"type": "External",
"own": false
},
{
"id": "6",
"nombre": "Característica personalizada",
"name": "",
"own": true
},
"status": "success"
}
# Certificado Energético
Para consultar y actualizar la informacion de Certificado energético de la propiedad
❗️ Nota
Esta información solo aplica para propiedades en España.
# Consultar Certificado Energético
Para consultar el Certificado energético de una propiedad en Wasi, cuentas con la URI:
api.wasi.co/v1/property/energy-certificate/get/#id_property
Por ejemplo para una propiedad cuyo id_property es 1, la URI sería:
api.wasi.co/v1/property/energy-certificate/get/1
Despues de enviar los parametros correctamente debería devolver un JSON como el siguiente:
{
"is_certified":"Yes",
"certificate_type":"Projects",
"energy_rating":"E",
"ipe":0,
"energy_rating_emission": "D",
"ipe_emission": 0,
"until_date": "2022-04-23",
"status":"success"
}
# Actualizar Certificado Energético
Para actualizar el Certificado energético de una propiedad en Wasi, cuentas con la URI:
api.wasi.co/v1/property/energy-certificate/update/#id_property
Por ejemplo para una propiedad cuyo id_property es 1, y se quiere actualizar e indicar que tiene un certificado de tipo Proyectos, con calificación energética C e IPE 50 y con calificación de emission E e IPE de emision 51, la URI sería:
api.wasi.co/v1/property/energy-certificate/update/1?is_certified=2&certificate_type=2&energy_rating=5&ipe=50&energy_rating_emission=7&ipe_emission=51
# Propietarios
Puedes obtener los propietarios de una propiedad con la siguiente URI usar la URI:
api.wasi.co/v1/property/owner/#id_property
Si todo esta en orden, esto debería retornar un JSON similar al siguiente:
{
"0": {
"id_client": 1,
"id_user": 1,
"id_client_type": 5,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindío",
"id_city": 63,
"city_label": "Armenia",
"id_client_status": 1,
"first_name": "John",
"last_name": "Doe",
"birthday": "1948-10-10",
"identification": "",
"email": "[email protected]",
"phone": "7111111",
"cell_phone": "3111111111",
"address": "Calle 1 # 1-11",
"query": "",
"comment": "",
"reference": "",
"send_information": true,
"created_at": "2011-09-11 17:12:12",
"updated_at": "0000-00-00 00:00:00"
},
"total": 1,
"status": "success"
}
# Paginación
| Filtro | Tipo | Representa |
|---|---|---|
| skip | Number | Offset, indica desde donde se muestran los registros, 0 por defecto (desde el inicio, sin omitir ninguno). |
| take | Number | Limit, cantidad de elementos a listar, 10 por defecto (100 como máximo). |
❗️ Importante
Para todas las peticiones es necesario el envío de credenciales, para más información puedes visitar la sección de Primeros pasos.
# Portales aliados
Al crear o editar una propiedad se puede enviar un array con los ids de los portales en el parametro portals, por ejemplo si se quiere actualizar la propiedad con id 1234, para que se sincronize con los portales con id 2 y 4, podemos enviar este parametro tanto via URL como JSON y seria algo asi en el primer caso:
http://api.wasi.co/v1/property/update/1234?portals[]=2&portals[]=4
❗️ Importante
El array de portales es opcional, sin embargo cuando se envia será validado, si se esta actualizando una propiedad y no se envía el array se conservaran los valores existentes, si se envía un nuevo array sustituira el previo.
❗️ Importante
Cuando se agrega una propiedad nueva y no se envía un array de portales, por defecto se creará con todos los portales activos para sincronizacion.
La API de Wasi permite obtener el listado de los portales aliados válidos para la empresa, para ello se cuenta con la URI:
api.wasi.co/v1/portal/all
Esto debería retornar un JSON similar a este:
{
"0": {
"id": 43,
"name": "Mercadolibre"
},
"1": {
"id": 30,
"name": "Icasas"
},
"2": {
"id": 44,
"name": "Inmuebles24"
},
"3": {
"id": 22,
"name": "Goplaceit"
},
"4": {
"id": 2,
"name": "Lamudi"
},
"5": {
"id": 50,
"name": "Vivanuncios"
},
"6": {
"id": 24,
"name": "Tuad"
},
"7": {
"id": 32,
"name": "Los compradores"
},
"status": "success"
}
Para solicitar la información del estado del portal relativa a un inmueble se usa la siguiente URI:
api.wasi.co/v1/portal/property/#id_property
Esto debería retornar un JSON similar a este:
{
"0": {
"id": 43,
"name": "Mercadolibre",
"active": true
},
"1": {
"id": 30,
"name": "Icasas",
"active": false
},
"2": {
"id": 44,
"name": "Inmuebles24",
"active": false
},
"3": {
"id": 22,
"name": "Goplaceit",
"active": false
},
"4": {
"id": 2,
"name": "Lamudi",
"active": false
},
"5": {
"id": 50,
"name": "Vivanuncios",
"active": true
},
"6": {
"id": 24,
"name": "Tuad",
"active": false
},
"7": {
"id": 32,
"name": "Los compradores",
"active": true
},
"status": "success"
}
# Clientes de una propiedad
Puedes obtener los clientes asociados a una propiedad con la siguiente URI usar la URI:
api.wasi.co/v1/property/clients/#id_property
Si todo esta en orden, esto debería retornar un JSON similar al siguiente:
{
"0": {
"id_client": 1234,
"first_name": "Pepito Perez",
"last_name": "Perez",
"id_client_type": 5,
"client_type_label": "Propietario",
"id_user": 1234,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindío",
"id_city": 63,
"city_label": "Armenia",
"id_client_status": 2,
"client_status_label": "En Proceso",
"birthday": "0000-00-00",
"identification": "",
"email": "[email protected]",
"phone": "",
"cell_phone": "1234567",
"address": "",
"query": "",
"comment": "",
"reference": "",
"send_information": true,
"created_at": "2015-04-15 11:26:52",
"updated_at": "2019-03-29 11:18:50"
},
"1": {
"id_client": 1235,
"first_name": "Joe",
"last_name": "Doe",
"id_client_type": 1,
"client_type_label": "Comprador",
"id_user": 1234,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindío",
"id_city": 63,
"city_label": "Armenia",
"id_client_status": 2,
"client_status_label": "En Proceso",
"birthday": "0000-00-00",
"identification": "",
"email": "[email protected]",
"phone": "",
"cell_phone": "1234567",
"address": "",
"query": "",
"comment": "",
"reference": "",
"send_information": true,
"created_at": "2015-04-15 11:26:52",
"updated_at": "2019-03-29 11:18:50"
},
"total": 2,
"status": "success"
}
❗️ Importante
El valor retornado id_client_type corresponde al tipo de asociacion del cliente con el inmueble, es un valor diferente al que se obtiene cuando se consulta el tipo del cliente directamente.
# Filtrado
Los filtros son opcionales, a continuación se listan los filtros exitentes para la búsqueda de clientes.
| Filtro | Tipo | Detalle |
|---|---|---|
| id_client_type | Number | Id del tipo de cliente, ver Tipos de cliente. |
# Paginación
| Filtro | Tipo |
|---|---|
| skip | Number Offset, indica desde donde se muestran los registros, 0 por defecto (desde el inicio, sin omitir ninguno). |
| take | Number Limit, cantidad de elementos a listar, 10 por defecto (100 como máximo). |
❗️ Importante
Para todas las peticiones es necesario el envío de credenciales, para más información puedes visitar la sección de Primeros pasos.
# Propiedades destacadas
Puedes obtener las propiedades destacadas con la siguiente URI:
api.wasi.co/v1/property/highlighted/
Si todo esta en orden, esto debería retornar un JSON similar al siguiente:
{
"0": {
"id_property": 1,
"id_company": 1,
"id_user": 1,
"for_sale": "true",
"for_rent": "true",
"for_transfer": "false",
"id_property_type": 14,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindio",
"id_city": 63,
"city_label": "Armenia",
"id_location": 0,
"location_label": "",
"id_zone": 0,
"zone_label": "",
"id_currency": 1,
"iso_currency": "COP",
"name_currency": "Pesos Colombianos",
"title": "SV65850-44301",
"address": "Av/ de la peseta # 110 - 25",
"area": "79",
"id_unit_area": "1",
"unit_area_label": "M2",
"built_area": "",
"id_unit_built_area": "1",
"unit_built_area_label": "M2",
"private_area": "",
"id_unit_private_area": "1",
"unit_private_area_label": "M2",
"maintenance_fee": "0",
"sale_price": "150000000",
"sale_price_label": "$150.000.000",
"rent_price": "0",
"rent_price_label": "$0",
"bedrooms": "2",
"bathrooms": "1",
"garages": "0",
"floor": "",
"observations": "Aqui las observaciones del ejemplo 1",
"video": "https:\/\/vimeo.com\/88462167",
"id_property_condition": "2",
"property_condition_label": "Used",
"id_status_on_page": "3",
"status_on_page_label": "Outstanding",
"map": "",
"latitude": "",
"longitude": "",
"building_date": "",
"network_share": false,
"visits": 79,
"created_at": "2015-09-07 16:22:45",
"updated_at": "2016-04-06 14:40:01",
"reference": "",
"comment": "",
"id_rents_type": "4",
"rents_type_label": "Monthly",
"zip_code": "",
"id_availability": "2",
"availability_label": "Sold",
"id_publish_on_map": "1",
"publish_on_map_label": "Do not post",
"main_image": {
"id_gallery": "112861",
"id_image": "4096458",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo12.jpg",
"description": "",
"position": "1"
},
"galleries": [
{
"id": "112861",
"0": {
"id": "4096458",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo12.jpg",
"description": "",
"position": "1"
},
"1": {
"id": "4096459",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo14.jpg",
"description": "",
"position": "2"
},
"2": {
"id": "4096460",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo16.jpg",
"description": "",
"position": "3"
}
}
],
"features": {
"internal": [
{
"id": "84",
"nombre": "Armarios empotrados",
"name": ""
},
{
"id": "5",
"nombre": "Balcón",
"name": ""
}
],
"external": [
{
"id": "78",
"nombre": "Área social",
"name": ""
}
]
},
"label": "Parque central",
"owner": "own"
},
"1": {
"id_property": 2,
"id_company": 1,
"id_user": 1,
"for_sale": "true",
"for_rent": "true",
"for_transfer": "false",
"id_property_type": 7,
"id_country": 1,
"country_label": "Colombia",
"id_region": 26,
"region_label": "Quindio",
"id_city": 129,
"city_label": "Calarca",
"id_location": 0,
"location_label": "",
"id_zone": 22170,
"zone_label": "Vereda",
"id_currency": 1,
"iso_currency": "COP",
"title": "Finca en venta El Paraiso, Vereda Floresta Calarca",
"address": "Finca el Paraiso, vereda la Floresta. Calarca, Quindio",
"area": "6400",
"id_unit_area": "1",
"unit_area_label": "M2",
"built_area": "",
"id_unit_built_area": "1",
"unit_built_area_label": "M2",
"maintenance_fee": "0",
"sale_price": "289000000",
"sale_price_label": "$289.000.000",
"rent_price": "0",
"rent_price_label": "$0",
"bedrooms": "4",
"bathrooms": "1",
"garages": "1",
"floor": "Rural",
"furnished": "false",
"observations": "Aqui las observaciones del ejemplo 2",
"video": "",
"id_property_condition": "2",
"property_condition_label": "Used",
"id_status_on_page": "3",
"status_on_page_label": "Outstanding",
"map": "4.529195895731443,-75.63777923583984",
"latitude": "4.529195895731443",
"longitude": "-75.63777923583984",
"building_date": "",
"network_share": true,
"visits": 404,
"created_at": "2015-07-08 07:39:18",
"updated_at": "2015-08-12 11:25:50",
"reference": "",
"comment": "",
"id_rents_type": "4",
"rents_type_label": "Monthly",
"zip_code": "630001",
"id_availability": "1",
"availability_label": "Available",
"id_publish_on_map": "1",
"publish_on_map_label": "Do not post",
"main_image": {
"id_gallery": "105232",
"id_image": "4052247",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo22.jpg",
"description": "",
"position": "1"
},
"galleries": [
{
"id": "105232",
"0": {
"id": "4052247",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo22.jpg",
"description": "",
"position": "1"
},
"1": {
"id": "4052248",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo24.jpg",
"description": "",
"position": "2"
},
"2": {
"id": "4052249",
"url": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_big": "https:\/\/images.wasi.co\/eyJidWNrZXQiOiJzdciLCJlZGl0cyI6eyJub3JtYWxp",
"url_original": "https:\/\/images.wasi.co\/inmuebles\/ejemplo26.jpg",
"description": "",
"position": "3"
}
}
],
"features": {
"internal": [
{
"id": "2",
"nombre": "Alarma",
"name": ""
},
{
"id": "4",
"nombre": "Amoblado",
"name": ""
}
],
"external": [
{
"id": "53",
"nombre": "Árboles frutales",
"name": ""
}
]
},
"label": "",
"owner": "own"
},
"total": "2",
"status": "success"
}
❗️ Importante
La cantidad de propiedades retornadas esta limitada por la cantidad que se haya indicado en la opción featured en Configración sitio web.
# Filtrado
A continuación se listan los filtros exitentes para el tipo de imagen.
| Filtro | Tipo | Detalle |
|---|---|---|
| for_sale | Boolean | Inmueble en venta |
| for_rent | Boolean | Inmueble esta diponible para la renta |
| for_transfer | Boolean | Inmueble esta diponible para permutar(transferencia). |
| short | Boolean | Si se envía como true no se muestra en la respuesta los listados de Galerías y Características |
# Filtrado adicional
Aplican opciones de filtrado definidas en Galerías de imágenes de la propiedad.
❗️ Importante
Si se envía el parametro short con valor true retorna una versión reducida de la propiedad, sin el listado de Galerías y Características. Estos listado se pueden obtener de forma independiente como esta indicado en Galerías de la propiedad, y Características de la propiedad.
❗️ Importante
Para todas las peticiones es necesario el envío de credenciales, para más información puedes visitar la sección de Primeros pasos.
# Compartir en redes sociales
Para compartir la propiedad en redes sociales se tiene la URI:
api.wasi.co/v1/property/social-sharing/#id_property
Por ejemplo para una propiedad cuyo id_property es 1, y se quiere publicar en facebook y en twitter, la URI sería:
api.wasi.co/v1/property/social-sharing/1?twitter=true&facebook=true
# Opciones de publicación
| Red social | Tipo | Descripción |
|---|---|---|
| Boolean | Indica si el inmueble debe ser compartido en la red social facebook. | |
| Boolean | Indica si el inmueble debe ser compartido en la red social twitter. |
❗️ Importante
Iniciando sesión en wasi.co puedes configurar las redes sociales (Configuración / Ajustes generales) y ver las notificaciones que se generen en el proceso de publicación.
# Generar PDF
Para generar el PDF de una propiedad se tiene la URI:
api.wasi.co/v1/property/make-pdf/#id_property
Por ejemplo para una propiedad cuyo id_property es 1, y se quiere generar el PDF, la URI sería:
api.wasi.co/v1/property/make-pdf/1
❗️ Importante
Para todas las peticiones es necesario el envío de credenciales, para más información puedes visitar la sección de Primeros pasos.
# Documentos
Puedes obtener los documentos de una propiedad con la siguiente URI:
api.wasi.co/v1/property/#id_property/documents/all
Si todo esta en orden, esto debería retornar un JSON similar al siguiente:
{
"0": {
"id_category": 1,
"category": "Contratos",
"files": [
{
"id_file": 1015,
"name": "Capture d’écran 2020-06-27 à 12.45.46 AM.png",
"title": "Captur...6 AM.png"
},
{
"id_file": 1017,
"name": "Guia ejercicios de Autocuidado.pdf",
"title": "Guia e...dado.pdf"
}
]
},
"1": {
"id_category": 2,
"category": "Fotocopias",
"files": [
{
"id_file": 1016,
"name": "19juncovid.jpg",
"title": "19juncovid.jpg"
}
]
},
"2": {
"id_category": 3,
"category": "Facturas",
"files": []
},
"3": {
"id_category": 4,
"category": "Anexos",
"files": []
},
"4": {
"id_category": 5,
"category": "Varios",
"files": []
},
"status": "success"
}
❗️ Importante
Los documentos son agrupados por categorias.
Para obtener un documento cuentas con la siguiente URI:
http://api.wasi/v1/property/#id_property/documents/get/#id_file
# Subir un documento
Para subir un documento de una propiedad en Wasi, cuentas con la URI:
POST api.wasi.co/v1/property/#id_property/documents/upload
Para subir un documento a la propiedad de ejemplo cuyo id_property es 1, la URI seria:
api.wasi.co/v1/property/1/documents/upload
El documento (file) debe enviarse en el parametro llamado file. En la siguiente tabla se listan los parametros soportados por la URI de subida de documento:
| Parametro | Tipo | Descripción | Obligatorio |
|---|---|---|---|
| file | File | Es el archivo que se envia desde un form html que se desea subir | Sí |
| id_category | Number | Indica la categoría a la que pertenece el documento, ver Categorias documentos | No |
# Eliminar un documento
Para eliminar un documento de una propiedad en Wasi, cuentas con la URI:
POST api.wasi.co/v1/property/#id_property/documents/#id_file/delete
Para eliminar el documento 3 de la propiedad de ejemplo cuyo id_property es 1, la URI seria:
api.wasi.co/v1/property/1/documents/3/delete
❗️ Importante
Para todas las peticiones es necesario el envío de credenciales, para más información puedes visitar la sección de Primeros pasos.
# Obtener la comisión
Para obtener la comision de una propiedad en Wasi, cuentas con la URI:
GET v1/property/get-commission/IDPROPERTY
Si todo esta en orden, esto debería retornar un JSON similar al siguiente:
{
"commission_type": "percent",
"commission_value": "16",
"external_commission_active": true,
"external_commission_type": "percent",
"external_commission_value": "4",
"external_commission_note": "nota comision",
"exclusivity_contract": true,
"exclusivity_contract_date": "2022-02-02 00:00:00",
"status": "success"
}
# Actualizar la comisión
Para actualizar la comision de una propiedad en Wasi, cuentas con la URI:
POST /v1/property/update-commission/IDPROPERTY
Si todo esta en orden, esto debería retornar un JSON similar al siguiente:
{
"status": "success"
}
En la siguiente tabla se listan los parametros soportados por la URI de actualizacion de comision:
| Parametro | Tipo | Descripción |
|---|---|---|
| commission_type | String | Tipo de comision, Valores posibles: percent, amount |
| commission_value | Number | Valor de la comision |
| external_commission_type | String | Tipo de comision externa, Valores posibles: percent, amount |
| external_commission_value | Number | Valor de la comision |
| external_commission_note | String | Nota para la comision |
| external_commission_active | Boolean | Indica si la comision externa esta activa o no |
| exclusivity_contract | Boolean | Indica si tiene cotrato de exclusividad |
| exclusivity_contract_date | date | Indica la fecha del contrato, Formato: Y-m-d |