Estato
Estato

DOMUS - REST API


INSERCIÓN DE INMUEBLES

Consulta General

Función que muestra todos los inmuebles de la inmobiliaria o sucursal en cuestión presentes en la base de datos de Domus. No discrimina en su estado y trae gran cantidad de información.
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "http://api.domus.la/inmuebles",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "authorization: TOKEN_INGRESO",
    ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
                                
{
  "total": 1718,
  "per_page": 1,
  "current_page": 1,
  "last_page": 1718,
  "next_page_url": "http://api.domus.la/inmuebles/?page=2",
  "prev_page_url": null,
  "from": 1,
  "to": 1,
  "data": [
    {
      "idpro": 123456789,
      "codpro": 12345,
      "address": "Property Address",
      "city": 12345,
      "zone": 1,
      "neighborhood": "Brisas De Los Alamos",
      "type": 1,
      "biz": 1,
      "area_cons": 51,
      "area_lot": 0,
      "floor_type": "Ceramica ",
      "floor": "",
      "bedrooms": 3,
      "bathrooms": 1,
      "stratum": 3,
      "rent": 680000,
      "administration": 141100,
      "saleprice": 0,
      "description": "Here comes the property's general description",
      "descripcionmetrocuadrado": "Here comes the property's description for MetroCuadrado's portal",
      "desc_eng": "",
      "desc_fre": "",
      "resctrictions": "",
      "comment": "",
      "comment2": "",
      "video": "https://www.youtube.com/watch?v=iB1hZaeKsul8&feature=youtu.be",
      "visits": 0,
      "parking": 1,
      "parking_covered": 0,
      "consignation_date": "0000-00-00",
      "registry_date": "2017-01-18 09:08:16",
      "latitude": "3.4966725342944",
      "longitude": "-76.49851083755",
      "status": 1,
      "build_year": 2000,
      "destacado": "",
      "building_unit": "",
      "branch": 3010,
      "window_sign": 0,
      "front": 0,
      "rear": 0,
      "private_area": 0,
      "proyect_id": 0,
      "destination_id": 1,
      "neighborhood_id": 0,
      "show_portal": 0,
      "publication_date": "0000-00-00 00:00:00",
      "update_date": "2017-01-18 09:08:38",
      "id_portal": 0,
      "commission_percentage": 0,
      "matricula_number": "",
      "images": [
        {
          "id": 5466815,
          "order": 1,
          "imagename": "74738_1_1484748497.jpg",
          "imageurl": "http://pictures.domus.la/inmobiliaria_301/74738_1_1484748497.jpg",
          "thumburl": "http://pictures.domus.la/inmobiliaria_301/74738_1_min1484748497.jpg",
          "inmueble": 362387
        },
        {
          "id": 5466832,
          "order": 18,
          "imagename": "74738_1_1484748517.jpg",
          "imageurl": "http://pictures.domus.la/inmobiliaria_301/74738_1_1484748517.jpg",
          "thumburl": "http://pictures.domus.la/inmobiliaria_301/74738_1_min1484748517.jpg",
          "inmueble": 362387
        }
      ]
    }
  ]
}
                                
por header

Parametro Descripcion Ejemplo
Authorization Token : Llave de acceso 'authorization' => 'TOKEN_AUTENTICACION'
Perpage Cantidad de Inmuebles por página 'perpage' => 3
Inmobiliaria Muestra todos los inmuebles de la inmobiliaria 'inmobiliaria' => 1

Consulta de un Inmueble

Función que muestra toda la información general de un inmueble específico por su código.
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "http://api.domus.la/inmuebles/123456",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "authorization: TOKEN_INGRESO",
    ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
                                
{
  "data": [
    {
      "idpro": 123456789,
      "codpro": 12345,
      "address": "Property Address",
      "city": 12345,
      "zone": 1,
      "neighborhood": "Brisas De Los Alamos",
      "type": 1,
      "biz": 1,
      "area_cons": 51,
      "area_lot": 0,
      "floor_type": "Ceramica ",
      "floor": "",
      "bedrooms": 3,
      "bathrooms": 1,
      "stratum": 3,
      "rent": 680000,
      "administration": 141100,
      "saleprice": 0,
      "description": "Here comes the property's general description",
      "descripcionmetrocuadrado": "Here comes the property's description for MetroCuadrado's portal",
      "desc_eng": "",
      "desc_fre": "",
      "resctrictions": "",
      "comment": "",
      "comment2": "",
      "video": "https://www.youtube.com/watch?v=iB1hZaeKsul8&feature=youtu.be",
      "visits": 0,
      "parking": 1,
      "parking_covered": 0,
      "consignation_date": "0000-00-00",
      "registry_date": "2017-01-18 09:08:16",
      "latitude": "3.4966725342944",
      "longitude": "-76.49851083755",
      "status": 1,
      "build_year": 2000,
      "destacado": "",
      "building_unit": "",
      "branch": 3010,
      "window_sign": 0,
      "front": 0,
      "rear": 0,
      "private_area": 0,
      "proyect_id": 0,
      "destination_id": 1,
      "neighborhood_id": 0,
      "show_portal": 0,
      "publication_date": "0000-00-00 00:00:00",
      "update_date": "2017-01-18 09:08:38",
      "id_portal": 0,
      "commission_percentage": 0,
      "matricula_number": "",
      "images": [
        {
          "id": 5466815,
          "order": 1,
          "imagename": "74738_1_1484748497.jpg",
          "imageurl": "http://pictures.domus.la/inmobiliaria_301/74738_1_1484748497.jpg",
          "thumburl": "http://pictures.domus.la/inmobiliaria_301/74738_1_min1484748497.jpg",
          "inmueble": 362387
        },
        {
          "id": 5466832,
          "order": 18,
          "imagename": "74738_1_1484748517.jpg",
          "imageurl": "http://pictures.domus.la/inmobiliaria_301/74738_1_1484748517.jpg",
          "thumburl": "http://pictures.domus.la/inmobiliaria_301/74738_1_min1484748517.jpg",
          "inmueble": 362387
        }
      ]
    }
  ]
}
                                
por header

Parametro Descripcion Ejemplo
Authorization Token : Llave de acceso 'authorization' => 'TOKEN_AUTENTICACION'
Inmobiliaria Muestra todos los inmuebles de la inmobiliaria 'inmobiliaria' => 1
Por URL

Parametro Descripcion Ejemplo
codpro Código de la propiedad api.domus.la/inmuebles/12345

Inserción de Inmuebles

A través de este método se insertan todos los inmuebles necesarios en la plataforma de Domus. Si se envía el parámetro que recibe, entonces debe ser enviado obligatoriamente.

Es importante que sólo se hagan hasta 12 peticiones por minuto ya que luego de ésto el api responderá un error 429 y bloqueará el usuario por 1 minuto.
$curl = curl_init();

curl_setopt_array($curl, array(
        CURLOPT_URL => "http://api.domus.la/inmuebles",
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "POST",
        CURLOPT_POSTFIELDS => "codpro=12345&zone=3...",
        CURLOPT_HTTPHEADER => array(
        "authorization: TOKEN_INGRESO",
    ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
                                
{
    "idpro": 123456789,
    "codpro": 12345,
    "address": "Property Address",
    "city": 12345,
    "zone": 1,
    "neighborhood": "Brisas De Los Alamos",
    "type": 1,
    "biz": 1,
    "area_cons": 51,
    "area_lot": 0,
    "floor_type": "Ceramica ",
    "floor": "",
    "bedrooms": 3,
    "bathrooms": 1,
    "stratum": 3,
    "rent": 680000,
    "administration": 141100,
    "saleprice": 0,
    "description": "Here comes the property's general description",
    "descripcionmetrocuadrado": "Here comes the property's description for MetroCuadrado's portal",
    "desc_eng": "",
    "desc_fre": "",
    "resctrictions": "",
    "comment": "",
    "comment2": "",
    "video": "https://www.youtube.com/watch?v=iB1hZaeKsul8&feature=youtu.be",
    "visits": 0,
    "parking": 1,
    "parking_covered": 0,
    "consignation_date": "0000-00-00",
    "registry_date": "2017-01-18 09:08:16",
    "latitude": "3.4966725342944",
    "longitude": "-76.49851083755",
    "status": 1,
    "build_year": 2000,
    "destacado": "",
    "building_unit": "",
    "branch": 3010,
    "window_sign": 0,
    "front": 0,
    "rear": 0,
    "private_area": 0,
    "proyect_id": 0,
    "destination_id": 1,
    "neighborhood_id": 0,
    "show_portal": 0,
    "publication_date": "0000-00-00 00:00:00",
    "update_date": "2017-01-18 09:08:38",
    "id_portal": 0,
    "commission_percentage": 0,
    "matricula_number": "",
    "images": [
        {
            "id": 5466815,
            "order": 1,
            "imagename": "74738_1_1484748497.jpg",
            "imageurl": "http://pictures.domus.la/inmobiliaria_301/74738_1_1484748497.jpg",
            "thumburl": "http://pictures.domus.la/inmobiliaria_301/74738_1_min1484748497.jpg",
            "inmueble": 362387
        },
        {
            "id": 5466832,
            "order": 18,
            "imagename": "74738_1_1484748517.jpg",
            "imageurl": "http://pictures.domus.la/inmobiliaria_301/74738_1_1484748517.jpg",
            "thumburl": "http://pictures.domus.la/inmobiliaria_301/74738_1_min1484748517.jpg",
            "inmueble": 362387
        }
    ]
}
                                    
Por Header

Parametro Descripcion Ejemplo
Authorization Token : Llave de acceso 'authorization' => 'TOKEN_AUTENTICACION'
Por URL

Parametro Descripcion Ejemplo
codpro * Es el código de la propiedad, debe ser único para cada Inmueble de la Inmobiliaria 'codpro' => '12345'
city * Ciudad en que se encuentra el inmueble &city=11001
address * Dirección actual del inmueble &address=11001
zone * Zona en que se encuentra el inmueble &address=11001
type * Tipo del Inmueble &type=1
biz * Gestión del Inmueble &type=1
area_lot Tamaño del área Lote del Inmueble &area_lot=500
area_cons Tamaño del área construída del inmueble &area_cons=400
build_year Año de Construcción del Inmueble &build_year=2017
floor Piso en que se encuentra el Inmueble &floor=2
floor_type Tipo del piso del inmueble &floor_type=Ceramica
parking Cantidad de parqueaderos con que cuenta el inmueble &parking=2
parking_covered Cantidad de parqueaderos cubiertos con que cuenta el inmueble &parking_covered=2
bedrooms * Cantidad de habitaciones con que cuenta el inmueble &bedrooms=2
bathrooms * Cantidad de baños con que cuenta el inmueble &bathrooms=2
stratum * Estrato de la ubicación del Inmueble &stratum=2
administration Precio de la administración del inmueble &administration=2
resctrictions Restricciones del Inmueble &resctrictions=SomeRestriction
comment - comment2 Comentarios sobre el inmueble &comment=someComment &commet2=SomeComment
propietary Id del propietario del Inmueble si existe &propietary=2
saleprice * Precio de la venta del inmueble &saleprice=2
description * Descripción general del Inmueble &description=some description
desc_eng - desc_fre Descripción general del Inmueble &desc_eng=some description &desc_fre=some description
descripcionmetrocuadrado Descripción válida para portales como Metro Cuadrado &descripcionmetrocuadrado=some description without numbers
broker * Código del asesor que maneja el inmueble &broker=10
rent * Precio de Arriendo del Inmueble &rent=123456
status * Estado actual del inmueble &status=2
latitude - longitude * Representan la latitud y longitud de un inmueble en el mapa &latitude=3.4966725342944 &longitude=-76.49851083755
neighborhood * Barrio del Inmueble &neighborhood=BarrioEjemplo
neighborhood_id Código del Barrio del Inmueble &neighborhood_id=2
video Video del Inmueble &video=youtube.com/video
great Con el número 1 se destaca el inmueble &great=1
building_unit Unidad en que se encuentra el inmueble en un edificio &building_unit=1
window_sign Señal que se muestra en la ventana del Inmueble &window_sign=something
front Denominación del frente del inmueble &front=something
rear Denominación del fondo del inmueble &rear=something
private_area Denota si es un area privada &private_area=1
proyect_id Se asocia el id del proyecto si el inmueble hace parte de uno &proyect_id=1
destination * Se asocia a la destinación del inmueble &destination=1
image# Para insertar imágenes, donde (#) es el número de la imagen en cuestión &image1=http://www.somepicture.url.jpg
amenities Permite insertar todas las características de un inmueble &amenities=1,4,5,6

Actualización de Inmuebles

Permite actualizar todo un inmueble específico por su código de propiedad

Es importante que sólo se hagan hasta 12 peticiones por minuto ya que luego de ésto el api responderá un error 429 y bloqueará el usuario por 1 minuto.
$curl = curl_init();

curl_setopt_array($curl, array(
        CURLOPT_URL => "http://api.domus.la/inmuebles/12345",
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_ENCODING => "",
        CURLOPT_MAXREDIRS => 10,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
        CURLOPT_CUSTOMREQUEST => "PUT",
        CURLOPT_POSTFIELDS => "zone=3&description=SomeDescription...",
        CURLOPT_HTTPHEADER => array(
        "authorization: TOKEN_INGRESO",
    ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
                                
{
    "idpro": 123456789,
    "codpro": 12345,
    "address": "Property Address",
    "city": 12345,
    "zone": 1,
    "neighborhood": "Brisas De Los Alamos",
    "type": 1,
    "biz": 1,
    "area_cons": 51,
    "area_lot": 0,
    "floor_type": "Ceramica ",
    "floor": "",
    "bedrooms": 3,
    "bathrooms": 1,
    "stratum": 3,
    "rent": 680000,
    "administration": 141100,
    "saleprice": 0,
    "description": "Here comes the property's general description",
    "descripcionmetrocuadrado": "Here comes the property's description for MetroCuadrado's portal",
    "desc_eng": "",
    "desc_fre": "",
    "resctrictions": "",
    "comment": "",
    "comment2": "",
    "video": "https://www.youtube.com/watch?v=iB1hZaeKsul8&feature=youtu.be",
    "visits": 0,
    "parking": 1,
    "parking_covered": 0,
    "consignation_date": "0000-00-00",
    "registry_date": "2017-01-18 09:08:16",
    "latitude": "3.4966725342944",
    "longitude": "-76.49851083755",
    "status": 1,
    "build_year": 2000,
    "destacado": "",
    "building_unit": "",
    "branch": 3010,
    "window_sign": 0,
    "front": 0,
    "rear": 0,
    "private_area": 0,
    "proyect_id": 0,
    "destination_id": 1,
    "neighborhood_id": 0,
    "show_portal": 0,
    "publication_date": "0000-00-00 00:00:00",
    "update_date": "2017-01-18 09:08:38",
    "id_portal": 0,
    "commission_percentage": 0,
    "matricula_number": "",
    "images": [
        {
        "id": 5466815,
        "order": 1,
        "imagename": "74738_1_1484748497.jpg",
        "imageurl": "http://pictures.domus.la/inmobiliaria_301/74738_1_1484748497.jpg",
        "thumburl": "http://pictures.domus.la/inmobiliaria_301/74738_1_min1484748497.jpg",
        "inmueble": 362387
        },
        {
        "id": 5466832,
        "order": 18,
        "imagename": "74738_1_1484748517.jpg",
        "imageurl": "http://pictures.domus.la/inmobiliaria_301/74738_1_1484748517.jpg",
        "thumburl": "http://pictures.domus.la/inmobiliaria_301/74738_1_min1484748517.jpg",
        "inmueble": 362387
        }
    ]
}
                                    
Por Header

Parametro Descripcion Ejemplo
Authorization Token : Llave de acceso 'authorization' => 'TOKEN_AUTENTICACION'
Por URL

Parametro Descripcion Ejemplo
codpro Código de la Propiedad api.domus.la/inmuebles/123456
Por Solicitud

Parametro Descripcion Ejemplo
city Ciudad en que se encuentra el inmueble &city=11001
address Dirección actual del inmueble &address=11001
zone Zona en que se encuentra el inmueble &address=11001
type Tipo del Inmueble &type=1
biz Gestión del Inmueble &type=1
area_lot Tamaño del área Lote del Inmueble &area_lot=500
area_cons Tamaño del área construída del inmueble &area_cons=400
build_year Año de Construcción del Inmueble &build_year=2017
floor Piso en que se encuentra el Inmueble &floor=2
floor_type Tipo del piso del inmueble &floor_type=Ceramica
parking Cantidad de parqueaderos con que cuenta el inmueble &parking=2
parking_covered Cantidad de parqueaderos cubiertos con que cuenta el inmueble &parking_covered=2
bedrooms Cantidad de habitaciones con que cuenta el inmueble &bedrooms=2
bathrooms Cantidad de baños con que cuenta el inmueble &bathrooms=2
stratum Estrato de la ubicación del Inmueble &stratum=2
administration Precio de la administración del inmueble &administration=2
resctrictions Restricciones del Inmueble &resctrictions=SomeRestriction
comment - comment2 Comentarios sobre el inmueble &comment=someComment &commet2=SomeComment
propietary Id del propietario del Inmueble si existe &propietary=2
saleprice Precio de la venta del inmueble &saleprice=2
description Descripción general del Inmueble &description=some description
desc_eng - desc_fre Descripción general del Inmueble &desc_eng=some description &desc_fre=some description
descripcionmetrocuadrado Descripción válida para portales como Metro Cuadrado &descripcionmetrocuadrado=some description without numbers
broker Código del asesor que maneja el inmueble &broker=10
rent Precio de Arriendo del Inmueble &rent=123456
latitude - longitude Representan la latitud y longitud de un inmueble en el mapa &latitude=3.4966725342944 &longitude=-76.49851083755
neighborhood Barrio del Inmueble &neighborhood=BarrioEjemplo
neighborhood_id Código del Barrio del Inmueble &neighborhood_id=2
video Video del Inmueble &video=youtube.com/video
great Con el número 1 se destaca el inmueble &great=1
building_unit Unidad en que se encuentra el inmueble en un edificio &building_unit=1
window_sign Señal que se muestra en la ventana del Inmueble &window_sign=something
front Denominación del frente del inmueble &front=something
rear Denominación del fondo del inmueble &rear=something
private_area Denota si es un area privada &private_area=1
proyect_id Se asocia el id del proyecto si el inmueble hace parte de uno &proyect_id=1
destination Se asocia a la destinación del inmueble &destination=1
image# Para insertar imágenes, donde (#) es el número de la imagen en cuestión &image1=http://www.somepicture.url.jpg
images_truncate Para eliminar todas las imágenes de un inmueble &images_truncate=1
amenities_truncate Para eliminar todas las características de un inmueble &amenities_truncate=1

Cambio de estado de Inmueble

Permite actualizar el estado de un inmueble dado un código. Éste es el único método oficial actualmente para cambiar el estado de un inmueble.
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "http://api.domus.la/property/update/status/12345",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "status=1&description=SomeDescription...",
  CURLOPT_HTTPHEADER => array(
    "authorization: TOKEN_INGRESO",
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
                                
{
    "property_code": 12345,
    "property_id": 123456789,
    "date_changed": "2018-06-26",
    "status": "1",
    "status_name": "Disponible",
    "value": 0,
    "description": "API - Prueba 3",
    "registry_date": {
        "date": "2018-06-26 16:26:28.731749",
        "timezone_type": 3,
        "timezone": "America/Bogota"
    }
}
                                    
Por Header

Parametro Descripcion Ejemplo
Authorization Token : Llave de acceso 'authorization' => 'TOKEN_AUTENTICACION'
Por URL

Parametro Descripcion Ejemplo
codpro Código de la Propiedad api.domus.la/property/update/status/123456
Por Solicitud

Parametro Descripcion Ejemplo
status * Nuevo estado del inmueble &status=2
description Descripción del cambio de estado &description=SomeDescription...
change_date Fecha en que se cambió el estado del inmueble &change_date=2018-02-28...

Separación de Inmueble

Este método permite gestionar la separación de un inmueble desde Domus
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "http://api.domus.la/property/update/detach/12345",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "status=1&days=2...",
  CURLOPT_HTTPHEADER => array(
    "authorization: TOKEN_INGRESO",
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
                                
{
    "property_code": 12345,
    "property_id": 123456789,
    "status": "Separado",
    "days": "2",
    "comment": "prueba",
    "value": "5000",
    "active": "1"
}
                                    
Por Header

Parametro Descripcion Ejemplo
Authorization Token : Llave de acceso 'authorization' => 'TOKEN_AUTENTICACION'
Por URL

Parametro Descripcion Ejemplo
codpro Código de la Propiedad api.domus.la/property/update/detach/123456
Por Solicitud

Parametro Descripcion Ejemplo
status * Estado actual de la separación &status=2
days * Cantidad de días de vigencia de la separación &days=2
comment * Comentario de la separación o reserva del inmueble &comment=Prueba...
value * Valor en que se hizo la separación o reserva del inmueble &value=5000