API Arrendasoft V2

En esta sección, explicamos los servicios disponibles en la API REST de Arrendasoft®, permitiendo que plataformas externas se integren con cada una de las instancias de las inmobiliarias que utilizan Arrendasoft®.

Autenticación

En esta sección, explicaremos los servicios que se ofrecen para la gestión de autenticación en la API REST de Arrendasoft®.

Autenticación

Login

Permite realizar el login en la API, para obtener el token necesario a usar en los demás servicios.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/auth/login

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método POST
Content-Type application/json
Body 
{
    "username": "Aquí va el username dado por la inmobiliaria",
    "password": "Aquí va el password dado por la inmobiliaria"
}

Respuesta

{
  "message": null,
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2OTA0OTc1OTAsImV4cCI6MTY5MDU0MDc5MCwiZGF0YSI6eyJ0ZXJjZXJvX2lkIjoiNjQ4MiIsImRvY3VtZW50byI6InVzZXJfYXZhbnRvIn19.5OlAA_hg1NZ3xfjVqaDaf-j46JqiBcOUdHC1dwwUK38",
  "expiration": 1690540790
}
message Mensaje de un posible error por si se presenta.
token Token bearer para poder realizar la petición de contratos.
expiration Timestamp de expiración del token, su duración es de 1 hora.

Importante: Es importante tener en cuenta que al realizar solicitudes a otros servicios, es posible que el token expire. En tales casos, será necesario volver a autenticarse utilizando el servicio de login.

{
    "statusCode": 401,
    "error": {
        "type": "SERVER_ERROR",
        "description": "JWT Token expired."
    }
}

Maestras

En esta sección, detallaremos los servicios disponibles para consultar información de las entidades maestras en la API REST de Arrendasoft®

Maestras

Propiedades / Listar Estados

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada estado posible que puede tener una propiedad.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/masters/properties/states

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método GET
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login

Respuesta

Lista de elementos, donde cada elemento contiene la información de cada uno de los estados.

[
    {
        "id": 1,
        "estado": "Activa"
    },
    {
        "id": 0,
        "estado": "Arrendada"
    },
    {
        "id": 2,
        "estado": "Inactiva"
    },
    {
        "id": 3,
        "estado": "Vendida"
    }
]

Tabla con la descripción de cada campo del JSON

Clave Descripción
id Identificador único del estado
estado Descripción del estado

Maestras

Propiedades / Listar Clases de Inmueble

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada clase de inmueble posible que puede tener una propiedad.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/masters/properties/property-classes

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método GET
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login

Respuesta

Lista de elementos, donde cada elemento contiene la información de cada una de las clases de inmueble.

[
    {
        "id": "1367",
        "clase": "Amoblados"
    },
    {
        "id": "1253",
        "clase": "Apartaestudio"
    },
    {
        "id": "1247",
        "clase": "Apartamento"
    },
    {
        "id": "1248",
        "clase": "Bodega"
    },
    {
        "id": "1249",
        "clase": "Casa"
    },
]

Tabla con la descripción de cada campo del JSON

Clave Descripción
id Identificador único de la clase de inmueble
clase Descripción de la clase de inmueble

Maestras

Propiedades / Listar Tipos de Servicios

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada tipo de servicio que puede tener una propiedad.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/masters/properties/service-types

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método GET
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login

Respuesta

Lista de elementos, donde cada elemento contiene la información de cada uno de los tipos de servicios.

[
    {
        "id": "arriendo",
        "servicio": "Arriendo"
    },
    {
        "id": "venta",
        "servicio": "Venta"
    },
    {
        "id": "venta y arriendo",
        "servicio": "Venta y Arriendo"
    }
]

Tabla con la descripción de cada campo del JSON

Clave Descripción
id Identificador único del servicio
servicio Descripción del servicio

Maestras

Propiedades / Listar Características

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada característica que puede tener una propiedad.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/masters/properties/features

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método GET
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login

Respuesta

Lista de elementos, donde cada elemento contiene la información de cada una de las características.

[
    {
        "id": "1",
        "descripcion": "Nº De Habitaciones",
        "tipo_campo": "numeric",
        "opciones_valores": null,
        "opciones_descripciones": null,
        "orden": "1",
        "grupo": "Características del inmueble",
        "clase_inmueble_id": "1367",
        "clase_inmueble": "Amoblados"
    },
    {
        "id": "2",
        "descripcion": "Nº De Baños",
        "tipo_campo": "numeric",
        "opciones_valores": null,
        "opciones_descripciones": null,
        "orden": "2",
        "grupo": "Características del inmueble",
        "clase_inmueble_id": "1367",
        "clase_inmueble": "Amoblados"
    },
    {
        "id": "54",
        "descripcion": "Oficina",
        "tipo_campo": "checkbox",
        "opciones_valores": "",
        "opciones_descripciones": "",
        "orden": "3",
        "grupo": "Características del Inmueble",
        "clase_inmueble_id": "1248",
        "clase_inmueble": "Bodega"
    },
    {
        "id": "13",
        "descripcion": "Baño Auxiliar",
        "tipo_campo": "checkbox",
        "opciones_valores": null,
        "opciones_descripciones": null,
        "orden": "4",
        "grupo": "Características del Inmueble",
        "clase_inmueble_id": "1249",
        "clase_inmueble": "Casa"
    },
    {
        "id": "38",
        "descripcion": "Parqueadero",
        "tipo_campo": "select",
        "opciones_valores": "propio,visitantes",
        "opciones_descripciones": "Propio,Visitantes",
        "orden": "12",
        "grupo": "Características del Inmueble",
        "clase_inmueble_id": "1249",
        "clase_inmueble": "Casa"
    },
]

Tabla con la descripción de cada campo del JSON

Clave Descripción
id Identificador único de la característica
descripcion Descripción de la característica
tipo_campo Tipo de campo (ej. select, checkbox, numeric, etc.)
opciones_valores Valores posibles para el campo, separados por coma
opciones_descripciones Descripciones de las opciones, separadas por coma
orden Orden en que aparece el campo
grupo Grupo al que pertenece el campo
clase_inmueble_id Identificador de la clase de inmueble
clase_inmueble Tipo o clase de inmueble

Maestras

Propiedades / Listar Características por Clase de Inmueble

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada característica que puede tener una propiedad, filtrado por clase de inmueble.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/masters/properties/features/property-class/{{id}}

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método GET
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login
Parámetro {{id}}, corresponde al Identificador único de la clase de inmueble

Respuesta

Lista de elementos, donde cada elemento contiene la información de cada una de las características.

[
    {
        "id": "1",
        "descripcion": "Nº De Habitaciones",
        "tipo_campo": "numeric",
        "opciones_valores": null,
        "opciones_descripciones": null,
        "orden": "1",
        "grupo": "Características del Inmueble",
        "clase_inmueble_id": "1249",
        "clase_inmueble": "Casa"
    },
    {
        "id": "31",
        "descripcion": "Red de gas",
        "tipo_campo": "select",
        "opciones_valores": "si,no",
        "opciones_descripciones": "Si,No",
        "orden": "5",
        "grupo": "Características del Inmueble",
        "clase_inmueble_id": "1249",
        "clase_inmueble": "Casa"
    },
    {
        "id": "22",
        "descripcion": "Balcón",
        "tipo_campo": "checkbox",
        "opciones_valores": null,
        "opciones_descripciones": null,
        "orden": "10",
        "grupo": "Características del Inmueble",
        "clase_inmueble_id": "1249",
        "clase_inmueble": "Casa"
    },
    {
        "id": "38",
        "descripcion": "Parqueadero",
        "tipo_campo": "select",
        "opciones_valores": "propio,visitantes",
        "opciones_descripciones": "Propio,Visitantes",
        "orden": "12",
        "grupo": "Características del Inmueble",
        "clase_inmueble_id": "1249",
        "clase_inmueble": "Casa"
    }
]

Tabla con la descripción de cada campo del JSON

Clave Descripción
id Identificador único de la característica
descripcion Descripción de la característica
tipo_campo Tipo de campo (ej. select, checkbox, numeric, etc.)
opciones_valores Valores posibles para el campo, separados por coma
opciones_descripciones Descripciones de las opciones, separadas por coma
orden Orden en que aparece el campo
grupo Grupo al que pertenece el campo
clase_inmueble_id Identificador de la clase de inmueble
clase_inmueble Tipo o clase de inmueble

Propiedades

En esta sección, explicaremos los servicios que se ofrecen para la gestión de propiedades en la API REST de Arrendasoft®.

Propiedades

Listar Propiedades

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada una de las propiedades registradas en la inmobiliaria.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/properties

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método GET
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login
Parámetros
Parámetro Tipo Obligatorio

Valor por defecto

 Descripción
page integer No 1 Especifica la página de resultados que se desea recuperar al realizar la solicitud.
limit integer No 10 Especifica el número máximo de elementos que se deben devolver en la solicitud, el límite máximo es de 50.
listing_start_date string No

Representa la fecha de inicio del rango de fechas en el que un inmueble ha sido captado/consignado para su venta o alquiler.


Formato: YYYY/mm/dd
listing_end_date string No

Representa la fecha de fin del rango de fechas en el que un inmueble ha sido captado/consignado para su venta o alquiler.

 

Formato: YYYY/mm/dd
created_start_date
 string No

Representa la fecha de inicio del rango de fechas en el que un inmueble ha sido creado en el sistema.


Formato: YYYY/mm/dd
created_end_date
 string No

Representa la fecha de fin del rango de fechas en el que un inmueble ha sido creado en el sistema.

 

Formato: YYYY/mm/dd
last_modified_start_date
 string No

Representa la fecha de inicio del rango de fechas en el que un inmueble ha sido actualizado por ultima vez.


Formato: YYYY/mm/dd
last_modified_end_date
 string No

Representa la fecha de fin del rango de fechas en el que un inmueble ha sido actualizado por ultima vez.

 

Formato: YYYY/mm/dd

Nota: Para los parámetros de tipo fecha que se compongan de un rango, como listing_start_date y listing_end_date, se debe tener en cuenta que si se envía solo el start_date, se retornarán registros donde la condición es “>= (mayor o igual)”. Si solo se envía el end_date, se retornarán registros donde la condición es “<= (menos o igual)”, y si se envían ambas, entonces se retornarán registros dentro de ese rango de fechas.

Ejemplos de peticiones

https://{{instancia}}.arrendasoft.co/service/v2/public/properties
https://{{instancia}}.arrendasoft.co/service/v2/public/properties/
https://{{instancia}}.arrendasoft.co/service/v2/public/properties?page=1&limit=10
https://{{instancia}}.arrendasoft.co/service/v2/public/properties?page=1&limit=10&listing_start_date=2024-03-26
https://{{instancia}}.arrendasoft.co/service/v2/public/properties?page=1&limit=10&listing_start_date=2024-03-26&listing_end_date=2024-03-26

Respuesta

Lista de elementos, donde cada elemento contiene la información de cada una de las propiedades.

[
    {
        "codigo": "137",
        "titulo": "Apartamento cerca del estadio y la cuarta brigada",
        "clase_id": "1247",
        "clase_inmueble": "Apartamento",
        "tipo_servicio_id": "arriendo",
        "tipo_servicio": "Arriendo",
        "estrato": "1258",
        "estrato_texto": "Cuatro",
        "fecha_consignacion": "2024-04-26",
        "asesor_id": "5",
        "asesor": "InterServicios",
        "pais_id": "1",
        "pais": "COLOMBIA",
        "departamento_id": "5",
        "departamento": "Antioquia",
        "municipio_id": "1",
        "municipio": "Medellin",
        "barrio_id": "3",
        "barrio": "Estadio",
        "direccion": "CALLE 50 # 74 - 12",
        "coordenadas": "6.21505012838972:-75.57529436962885",
        "valor_arriendo1": "1600000",
        "valor_arriendo2": "0",
        "valor_venta1": "0",
        "valor_venta2": "0",
        "valor_administracion": "0",
        "avaluo_catastral": "0",
        "impuesto_predial": "0.00",
        "area": "75.00",
        "observaciones": null,
        "propiedad_destacada": "No",
        "llaves_en": "oficina",
        "llaves_otro": null,
        "paga_cuota_sost": "propietario",
        "folio_matricula": null,
        "referencia_catastral": null,
        "edificio_unidad": "urbanizacion",
        "estado": "1",
        "estado_texto": "Activa",
        "cantidad_images": "3",
        "cantidad_videos": "1",
        "caracteristicas": [
            {
                "id": "1",
                "descripcion": "Nº De Habitaciones",
                "tipo_campo": "numeric",
                "orden": "1",
                "grupo": "Características del inmueble",
                "valor": "4"
            },
            {
                "id": "2",
                "descripcion": "Nº De Baños",
                "tipo_campo": "numeric",
                "orden": "2",
                "grupo": "Características del inmueble",
                "valor": "3"
            },
            {
                "id": "5",
                "descripcion": "Nº De Piso",
                "tipo_campo": "numeric",
                "orden": "3",
                "grupo": "Características del inmueble",
                "valor": "1"
            },
            {
                "id": "4",
                "descripcion": " Antigüedad del Inmueble",
                "tipo_campo": "numeric",
                "orden": "5",
                "grupo": "Características del Inmueble",
                "valor": "3"
            },
            {
                "id": "14",
                "descripcion": "Cocina Integral",
                "tipo_campo": "checkbox",
                "orden": "5",
                "grupo": "Características Internas",
                "valor": "1"
            },
            {
                "id": "34",
                "descripcion": "Sala",
                "tipo_campo": "checkbox",
                "orden": "6",
                "grupo": "Características del Inmueble",
                "valor": "1"
            },
            {
                "id": "31",
                "descripcion": "Red de gas",
                "tipo_campo": "select",
                "orden": "5",
                "grupo": "Características del Inmueble",
                "valor": "si",
                "valor_texto": "Si"
            },
            {
                "id": "63",
                "descripcion": "Garaje",
                "tipo_campo": "checkbox",
                "orden": "10",
                "grupo": "Características Internas",
                "valor": "1"
            }
        ],
        "propietarios": [
            {
                "id": "272",
                "documento": "4207050496",
                "nombres": "CRISTINA GUERRERO",
                "apellidos": ""
            }
        ],
        "imagenes": [
            {
                "posicion": "1",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_66ae4cfba9aa891473fe8f78a0c7e6f6.jpeg"
            },
            {
                "posicion": "2",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_660ae9fb29a0ff3c0e47cf13cde4740e.jpeg"
            },
            {
                "posicion": "3",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_83883a0f75ddae325f41eafce4066631.jpeg"
            }
        ],
        "videos": [
            {
                "url": "608AV8w6gL0",
                "tipo": "youtube",
                "descripcion": null,
                "posicion": "1"
            }
        ]
    },
    {
        "codigo": "136",
        "titulo": "FINCA",
        "clase_id": "1254",
        "clase_inmueble": "Finca",
        "tipo_servicio_id": "venta y arriendo",
        "tipo_servicio": "Venta y Arriendo",
        "estrato": "1258",
        "estrato_texto": "Cuatro",
        "fecha_consignacion": "2021-04-16",
        "asesor_id": "6",
        "asesor": "KAREN CANO",
        "pais_id": "1",
        "pais": "COLOMBIA",
        "departamento_id": "11",
        "departamento": "Bogota D.c.",
        "municipio_id": "150",
        "municipio": "Bogota",
        "barrio_id": "838",
        "barrio": "Bosa",
        "direccion": "CR 145 # 85 - 9",
        "coordenadas": "4.875468815048683:-73.62556445019526",
        "valor_arriendo1": "6050000",
        "valor_arriendo2": "0",
        "valor_venta1": "500000000",
        "valor_venta2": "0",
        "valor_administracion": "0",
        "avaluo_catastral": "0",
        "impuesto_predial": "0.00",
        "area": "1200.00",
        "observaciones": "Esta finca ofrece una experiencia rural única con comodidades modernas. La espaciosa casa principal cuenta con encantadoras habitaciones, cuenta con una reluciente piscina y áreas verdes bien cuidadas.",
        "propiedad_destacada": "No",
        "llaves_en": "oficina",
        "llaves_otro": null,
        "paga_cuota_sost": null,
        "folio_matricula": "0",
        "referencia_catastral": "0",
        "edificio_unidad": "urbanizacion",
        "estado": "1",
        "estado_texto": "Activa",
        "cantidad_images": "2",
        "cantidad_videos": "0",
        "caracteristicas": [
            {
                "id": "1",
                "descripcion": "Nº De Habitaciones",
                "tipo_campo": "numeric",
                "orden": "1",
                "grupo": "Características del inmueble",
                "valor": "9"
            },
            {
                "id": "2",
                "descripcion": "Nº De Baños",
                "tipo_campo": "numeric",
                "orden": "2",
                "grupo": "Características del inmueble",
                "valor": "4"
            },
            {
                "id": "11",
                "descripcion": "Zona de lavandería",
                "tipo_campo": "checkbox",
                "orden": "14",
                "grupo": "Características del inmueble",
                "valor": "1"
            },
            {
                "id": "9",
                "descripcion": "Cuarto de servicio",
                "tipo_campo": "checkbox",
                "orden": "5",
                "grupo": "Características del Inmueble",
                "valor": "1"
            },
            {
                "id": "26",
                "descripcion": "Sauna / Turco / Jacuzzi",
                "tipo_campo": "checkbox",
                "orden": "6",
                "grupo": "Características del Inmueble",
                "valor": "1"
            }
        ],
        "propietarios": [
            {
                "id": "83",
                "documento": "2830863285",
                "nombres": "LILIA MARLEN",
                "apellidos": "LOPEZ CASTELLANOS"
            }
        ],
        "imagenes": [
            {
                "posicion": "1",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_431b70772304a609c280036305f66ac4.jpeg"
            },
            {
                "posicion": "2",
                "size": "19201080",
                "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_209e299b845c8bdf9479f5fb055461fe.jpeg"
            }
        ],
        "videos": []
    }
]
Claves y Descripciones del JSON de Propiedades

Esta tabla enumera las claves presentes en el JSON de una propiedad y proporciona una breve descripción de cada una, explicando su propósito y el tipo de información que contienen.

Clave Descripción
codigo Código del inmueble
titulo Título del anuncio del inmueble
clase_id ID de la clase del inmueble
clase_inmueble Clase del inmueble
tipo_servicio_id ID del tipo de servicio
tipo_servicio Tipo de servicio (arriendo/venta)
estrato ID del estrato del inmueble
estrato_texto Texto descriptivo del estrato
fecha_consignacion Fecha de consignación del inmueble
asesor_id ID del asesor
asesor Nombre del asesor
pais_id ID del país
pais Nombre del país
departamento_id ID del departamento
departamento Nombre del departamento
municipio_id ID del municipio
municipio Nombre del municipio
barrio_id ID del barrio
barrio Nombre del barrio
direccion Dirección del inmueble
coordenadas Coordenadas geográficas del inmueble
valor_arriendo1 Valor principal de arriendo
valor_arriendo2 Valor secundario de arriendo
valor_venta1 Valor principal de venta
valor_venta2 Valor secundario de venta
valor_administracion Valor de administración
avaluo_catastral Avalúo catastral del inmueble
impuesto_predial Impuesto predial
area Área del inmueble
observaciones Observaciones adicionales
propiedad_destacada Indicador de propiedad destacada
llaves_en Lugar donde están las llaves
llaves_otro Otro lugar donde están las llaves
paga_cuota_sost Quién paga la cuota de sostenimiento
folio_matricula Folio de matrícula
referencia_catastral Referencia catastral
edificio_unidad Nombre del edificio o unidad
estado ID del estado del inmueble
estado_texto Texto descriptivo del estado
cantidad_images Cantidad de imágenes del inmueble
cantidad_videos Cantidad de videos del inmueble
caracteristicas Lista de características del inmueble
propietarios Lista de propietarios
imagenes Lista de imágenes del inmueble
videos Lista de videos del inmueble
Características

Cada elemento dentro de la lista caracteristicas tiene las siguientes claves:

Clave Descripción
id ID de la característica
descripcion Descripción de la característica
tipo_campo Tipo de campo de la característica
orden Orden de la característica
grupo Grupo al que pertenece la característica
valor Valor de la característica
valor_texto Texto descriptivo del valor (si aplica)
Propietarios

Cada elemento dentro de la lista propietarios tiene las siguientes claves:

Clave Descripción
id ID del propietario
documento Documento de identificación
nombres Nombres del propietario
apellidos Apellidos del propietario
Imágenes

Cada elemento dentro de la lista imagenes tiene las siguientes claves:

Clave Descripción
posicion Posición de la imagen
size Tamaño de la imagen
imagen URL de la imagen
Videos

Cada elemento dentro de la lista videos tiene las siguientes claves:

Clave Descripción
url URL del video
tipo Tipo de video (e.g., YouTube)
descripcion Descripción del video
posicion Posición del video

Propiedades

Buscar Propiedad por Código

Permite obtener un elemento que contiene la información de la propiedad.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/properties/{{code}}

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método GET
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login
Parámetro {{code}}, corresponde al código de la propiedad a consultar

Ejemplo de petición

https://{{instancia}}.arrendasoft.co/service/v2/public/properties/137

Respuesta

Elemento con la información de la propiedad.

{
    "codigo": "137",
    "titulo": "Apartamento cerca del estadio y la cuarta brigada",
    "clase_id": "1247",
    "clase_inmueble": "Apartamento",
    "tipo_servicio_id": "arriendo",
    "tipo_servicio": "Arriendo",
    "estrato": "1258",
    "estrato_texto": "Cuatro",
    "fecha_consignacion": "2024-04-26",
    "asesor_id": "5",
    "asesor": "InterServicios",
    "pais_id": "1",
    "pais": "COLOMBIA",
    "departamento_id": "5",
    "departamento": "Antioquia",
    "municipio_id": "1",
    "municipio": "Medellin",
    "barrio_id": "3",
    "barrio": "Estadio",
    "direccion": "CALLE 50 # 74 - 12",
    "coordenadas": "6.21505012838972:-75.57529436962885",
    "valor_arriendo1": "1600000",
    "valor_arriendo2": "0",
    "valor_venta1": "0",
    "valor_venta2": "0",
    "valor_administracion": "0",
    "avaluo_catastral": "0",
    "impuesto_predial": "0.00",
    "area": "75.00",
    "observaciones": null,
    "propiedad_destacada": "No",
    "llaves_en": "oficina",
    "llaves_otro": null,
    "paga_cuota_sost": "propietario",
    "folio_matricula": null,
    "referencia_catastral": null,
    "edificio_unidad": "urbanizacion",
    "estado": "1",
    "estado_texto": "Activa",
    "cantidad_images": "3",
    "cantidad_videos": "1",
    "caracteristicas": [
        {
            "id": "1",
            "descripcion": "Nº De Habitaciones",
            "tipo_campo": "numeric",
            "orden": "1",
            "grupo": "Características del inmueble",
            "valor": "4"
        },
        {
            "id": "2",
            "descripcion": "Nº De Baños",
            "tipo_campo": "numeric",
            "orden": "2",
            "grupo": "Características del inmueble",
            "valor": "3"
        },
        {
            "id": "5",
            "descripcion": "Nº De Piso",
            "tipo_campo": "numeric",
            "orden": "3",
            "grupo": "Características del inmueble",
            "valor": "1"
        },
        {
            "id": "4",
            "descripcion": " Antigüedad del Inmueble",
            "tipo_campo": "numeric",
            "orden": "5",
            "grupo": "Características del Inmueble",
            "valor": "3"
        },
        {
            "id": "14",
            "descripcion": "Cocina Integral",
            "tipo_campo": "checkbox",
            "orden": "5",
            "grupo": "Características Internas",
            "valor": "1"
        },
        {
            "id": "34",
            "descripcion": "Sala",
            "tipo_campo": "checkbox",
            "orden": "6",
            "grupo": "Características del Inmueble",
            "valor": "1"
        },
        {
            "id": "31",
            "descripcion": "Red de gas",
            "tipo_campo": "select",
            "orden": "5",
            "grupo": "Características del Inmueble",
            "valor": "si",
            "valor_texto": "Si"
        },
        {
            "id": "63",
            "descripcion": "Garaje",
            "tipo_campo": "checkbox",
            "orden": "10",
            "grupo": "Características Internas",
            "valor": "1"
        }
    ],
    "propietarios": [
        {
            "id": "272",
            "documento": "4207050496",
            "nombres": "CRISTINA GUERRERO",
            "apellidos": ""
        }
    ],
    "imagenes": [
        {
            "posicion": "1",
            "size": "19201080",
            "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_66ae4cfba9aa891473fe8f78a0c7e6f6.jpeg"
        },
        {
            "posicion": "2",
            "size": "19201080",
            "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_660ae9fb29a0ff3c0e47cf13cde4740e.jpeg"
        },
        {
            "posicion": "3",
            "size": "19201080",
            "imagen": "https://qa.arrendasoft.co/img/fotos/1920x1080_83883a0f75ddae325f41eafce4066631.jpeg"
        }
    ],
    "videos": [
        {
            "url": "608AV8w6gL0",
            "tipo": "youtube",
            "descripcion": null,
            "posicion": "1"
        }
    ]
}
Claves y Descripciones del JSON de Propiedad

Esta tabla enumera las claves presentes en el JSON de una propiedad y proporciona una breve descripción de cada una, explicando su propósito y el tipo de información que contienen.

Clave Descripción
codigo Código del inmueble
titulo Título del anuncio del inmueble
clase_id ID de la clase del inmueble
clase_inmueble Clase del inmueble
tipo_servicio_id ID del tipo de servicio
tipo_servicio Tipo de servicio (arriendo/venta)
estrato ID del estrato del inmueble
estrato_texto Texto descriptivo del estrato
fecha_consignacion Fecha de consignación del inmueble
asesor_id ID del asesor
asesor Nombre del asesor
pais_id ID del país
pais Nombre del país
departamento_id ID del departamento
departamento Nombre del departamento
municipio_id ID del municipio
municipio Nombre del municipio
barrio_id ID del barrio
barrio Nombre del barrio
direccion Dirección del inmueble
coordenadas Coordenadas geográficas del inmueble
valor_arriendo1 Valor principal de arriendo
valor_arriendo2 Valor secundario de arriendo
valor_venta1 Valor principal de venta
valor_venta2 Valor secundario de venta
valor_administracion Valor de administración
avaluo_catastral Avalúo catastral del inmueble
impuesto_predial Impuesto predial
area Área del inmueble
observaciones Observaciones adicionales
propiedad_destacada Indicador de propiedad destacada
llaves_en Lugar donde están las llaves
llaves_otro Otro lugar donde están las llaves
paga_cuota_sost Quién paga la cuota de sostenimiento
folio_matricula Folio de matrícula
referencia_catastral Referencia catastral
edificio_unidad Nombre del edificio o unidad
estado ID del estado del inmueble
estado_texto Texto descriptivo del estado
cantidad_images Cantidad de imágenes del inmueble
cantidad_videos Cantidad de videos del inmueble
caracteristicas Lista de características del inmueble
propietarios Lista de propietarios
imagenes Lista de imágenes del inmueble
videos Lista de videos del inmueble
Características

Cada elemento dentro de la lista caracteristicas tiene las siguientes claves:

Clave Descripción
id ID de la característica
descripcion Descripción de la característica
tipo_campo Tipo de campo de la característica
orden Orden de la característica
grupo Grupo al que pertenece la característica
valor Valor de la característica
valor_texto Texto descriptivo del valor (si aplica)
Propietarios

Cada elemento dentro de la lista propietarios tiene las siguientes claves:

Clave Descripción
id ID del propietario
documento Documento de identificación
nombres Nombres del propietario
apellidos Apellidos del propietario
Imágenes

Cada elemento dentro de la lista imagenes tiene las siguientes claves:

Clave Descripción
posicion Posición de la imagen
size Tamaño de la imagen
imagen URL de la imagen
Videos

Cada elemento dentro de la lista videos tiene las siguientes claves:

Clave Descripción
url URL del video
tipo Tipo de video (e.g., YouTube)
descripcion Descripción del video
posicion Posición del video

Propiedades

Actualizar Estado de la Propiedad

Permite actualizar el estado de la propiedad.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/properties/{{code}}/status

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método PATCH
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login
Parámetro {{code}}, corresponde al código de la propiedad a consultar
Body 
{
    "status": Estado por el que se desea actualizar
}

Ejemplo de petición

https://{{instancia}}.arrendasoft.co/service/v2/public/properties/137/status

Body

{
    "status": 2
}

Respuesta

Mensaje que indica si el estado se actualizó correctamente o si se presentó algún error, junto con su respectivo código de respuesta HTTP.

{
    "message": "Se actualizo el estado de la propiedad correctamente"
}
message Mensaje indicando que se actualizo el estado o de un posible error por si se presenta.

El cambio de estado depende del estado actual de la propiedad. Por ejemplo, si la propiedad se encuentra actualmente en el estado 'Arrendada', el sistema no permitirá la actualización del estado.

Asesores

En esta sección, explicaremos los servicios que se ofrecen para la gestión de asesores en la API REST de Arrendasoft®.

Asesores

Listar Asesores

Permite obtener una lista de elementos, donde cada elemento contiene la información de cada uno de los asesores registrados en el sistema.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/agents

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método GET
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login

Respuesta

Lista de elementos, donde cada elemento contiene la información de cada uno de los asesores.

[
    {
        "id": "8",
        "documento": "12164587200",
        "nombre": "DANIEL RESTREPO",
        "telefono": "789456123",
        "email": "daniel.restrepo@interservicios.com",
        "path_photo": "https://localhost/arrendasoft/pic/iconos/user_photo.png"
    },
    {
        "id": "6",
        "documento": "1216727504",
        "nombre": "KAREN CANO",
        "telefono": "4447417",
        "email": "karen.cano@interservicios.com",
        "path_photo": "https://localhost/arrendasoft/pic/iconos/user_photo.png"
    }
]

Tabla con la descripción de cada campo del JSON

Clave Descripción
id Identificador único del usuario
documento Número de documento de identificación del usuario
nombre Nombre completo del usuario
telefono Número de teléfono del usuario
email Dirección de correo electrónico del usuario
path_photo URL a la foto del usuario

Asesores

Buscar Asesor por Documento

Permite obtener un elemento que contiene la información del asesor.

Endpoint: https://{{instancia}}.arrendasoft.co/service/v2/public/agents/{{document}}

{{instancia}}: Hace referencia a la instancia de cada inmobiliaria.

Petición

Método GET
Content-Type application/json
Authorization Bearer token, Token obtenido al consumir el servicio Login
Parámetro {{document}}, corresponde al número de documento del asesor a consultar

Ejemplo de petición

https://{{instancia}}.arrendasoft.co/service/v2/public/agents/1216727504

Respuesta

Elemento con la información de la propiedad.

{
    "id": "6",
    "documento": "1216727504",
    "nombre": "KAREN CANO",
    "telefono": "4447417",
    "email": "karen.cano@interservicios.com",
    "path_photo": "https://localhost/arrendasoft/pic/iconos/user_photo.png"
}

Tabla con la descripción de cada campo del JSON.

Clave Descripción
id Identificador único del usuario
documento Número de documento de identificación del usuario
nombre Nombre completo del usuario
telefono Número de teléfono del usuario
email Dirección de correo electrónico del usuario
path_photo URL a la foto del usuario